configuration_stores

Creates, updates, deletes, gets or lists a configuration_stores resource.

Overview

Name	configuration_stores
Type	Resource
Id	azure.app_configuration.configuration_stores

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
identity	object	The managed identity information, if configured.
location	string	The geo-location where the resource lives
properties	object	The properties of a configuration store.
sku	object	The sku of the configuration store.
systemData	object	Resource system metadata.
tags	object	Resource tags.

list_by_resource_group

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
identity	object	The managed identity information, if configured.
location	string	The geo-location where the resource lives
properties	object	The properties of a configuration store.
sku	object	The sku of the configuration store.
systemData	object	Resource system metadata.
tags	object	Resource tags.

list

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
identity	object	The managed identity information, if configured.
location	string	The geo-location where the resource lives
properties	object	The properties of a configuration store.
sku	object	The sku of the configuration store.
systemData	object	Resource system metadata.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, configStoreName		Gets the properties of the specified configuration store.
list_by_resource_group	select	subscriptionId, resourceGroupName	$skipToken	Lists the configuration stores for a given resource group.
list	select	subscriptionId	$skipToken	Lists the configuration stores for a given subscription.
create	insert	subscriptionId, resourceGroupName, configStoreName, data__location, data__sku		Creates a configuration store with the specified parameters.
update	update	subscriptionId, resourceGroupName, configStoreName		Updates a configuration store with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, configStoreName		Deletes a configuration store.
regenerate_key	exec	subscriptionId, resourceGroupName, configStoreName		Regenerates an access key for the specified configuration store.
purge_deleted	exec	subscriptionId, location, configStoreName		Permanently deletes the specified configuration store.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
configStoreName	string	The name of the configuration store.
location	string	The name of the Azure region.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$skipToken	string	A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

SELECT examples

get

Gets the properties of the specified configuration store.

SELECT
identity,
location,
properties,
sku,
systemData,
tags
FROM azure.app_configuration.configuration_stores
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND configStoreName = '{{ configStoreName }}' -- required
;

list_by_resource_group

Lists the configuration stores for a given resource group.

SELECT
identity,
location,
properties,
sku,
systemData,
tags
FROM azure.app_configuration.configuration_stores
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $skipToken = '{{ $skipToken }}'
;

list

Lists the configuration stores for a given subscription.

SELECT
identity,
location,
properties,
sku,
systemData,
tags
FROM azure.app_configuration.configuration_stores
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create

Creates a configuration store with the specified parameters.

INSERT INTO azure.app_configuration.configuration_stores (
data__tags,
data__location,
data__identity,
data__properties,
data__sku,
subscriptionId,
resourceGroupName,
configStoreName
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ sku }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ configStoreName }}'
RETURNING
identity,
location,
properties,
sku,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: configuration_stores
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the configuration_stores resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the configuration_stores resource.
    - name: configStoreName
      value: string
      description: Required parameter for the configuration_stores resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: identity
      value: object
      description: |
        The managed identity information, if configured.
    - name: properties
      value: object
      description: |
        The properties of a configuration store.
    - name: sku
      value: object
      description: |
        The sku of the configuration store.

UPDATE examples

update

Updates a configuration store with the specified parameters.

UPDATE azure.app_configuration.configuration_stores
SET 
data__properties = '{{ properties }}',
data__identity = '{{ identity }}',
data__sku = '{{ sku }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND configStoreName = '{{ configStoreName }}' --required
RETURNING
identity,
location,
properties,
sku,
systemData,
tags;

DELETE examples

delete

Deletes a configuration store.

DELETE FROM azure.app_configuration.configuration_stores
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND configStoreName = '{{ configStoreName }}' --required
;

Lifecycle Methods

regenerate_key

Regenerates an access key for the specified configuration store.

EXEC azure.app_configuration.configuration_stores.regenerate_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@configStoreName='{{ configStoreName }}' --required 
@@json=
'{
"id": "{{ id }}"
}'
;

purge_deleted

Permanently deletes the specified configuration store.

EXEC azure.app_configuration.configuration_stores.purge_deleted 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required, 
@configStoreName='{{ configStoreName }}' --required
;