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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
azureFrontDoor	object	Property specifying the configuration of Azure Front Door for this configuration store.
createMode	string	Indicates whether the configuration store need to be recovered. Known values are: "Recover" and "Default". (Recover, Default)
creationDate	string (date-time)	The creation date of configuration store.
dataPlaneProxy	object	Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM).
defaultKeyValueRevisionRetentionPeriodInSeconds	integer	The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores.
disableLocalAuth	boolean	Disables all authentication methods other than AAD authentication.
enablePurgeProtection	boolean	Property specifying whether protection against purge is enabled for this configuration store.
encryption	object	The encryption settings of the configuration store.
endpoint	string	The DNS endpoint where the configuration store API will be available.
identity	object	The managed identity information, if configured.
location	string	The geo-location where the resource lives. Required.
managedOnBehalfOfConfiguration	object	Managed On Behalf Of Configuration.
privateEndpointConnections	array	The list of private endpoint connections that are set up for this resource.
provisioningState	string	The provisioning state of the configuration store. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
publicNetworkAccess	string	Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". (Enabled, Disabled, SecuredByPerimeter)
sku	object	The sku of the configuration store. Required.
softDeleteRetentionInDays	integer	The amount of time in days that the configuration store will be retained when it is soft deleted.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
telemetry	object	Property specifying the configuration of telemetry for this configuration store.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_deleted

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configurationStoreId	string	The resource id of the original configuration store.
deletionDate	string (date-time)	The deleted date.
location	string	The location of the original configuration store.
purgeProtectionEnabled	boolean	Purge protection status of the original configuration store.
scheduledPurgeDate	string (date-time)	The scheduled purged date.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags of the original configuration store.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
azureFrontDoor	object	Property specifying the configuration of Azure Front Door for this configuration store.
createMode	string	Indicates whether the configuration store need to be recovered. Known values are: "Recover" and "Default". (Recover, Default)
creationDate	string (date-time)	The creation date of configuration store.
dataPlaneProxy	object	Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM).
defaultKeyValueRevisionRetentionPeriodInSeconds	integer	The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores.
disableLocalAuth	boolean	Disables all authentication methods other than AAD authentication.
enablePurgeProtection	boolean	Property specifying whether protection against purge is enabled for this configuration store.
encryption	object	The encryption settings of the configuration store.
endpoint	string	The DNS endpoint where the configuration store API will be available.
identity	object	The managed identity information, if configured.
location	string	The geo-location where the resource lives. Required.
managedOnBehalfOfConfiguration	object	Managed On Behalf Of Configuration.
privateEndpointConnections	array	The list of private endpoint connections that are set up for this resource.
provisioningState	string	The provisioning state of the configuration store. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
publicNetworkAccess	string	Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". (Enabled, Disabled, SecuredByPerimeter)
sku	object	The sku of the configuration store. Required.
softDeleteRetentionInDays	integer	The amount of time in days that the configuration store will be retained when it is soft deleted.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
telemetry	object	Property specifying the configuration of telemetry for this configuration store.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
azureFrontDoor	object	Property specifying the configuration of Azure Front Door for this configuration store.
createMode	string	Indicates whether the configuration store need to be recovered. Known values are: "Recover" and "Default". (Recover, Default)
creationDate	string (date-time)	The creation date of configuration store.
dataPlaneProxy	object	Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM).
defaultKeyValueRevisionRetentionPeriodInSeconds	integer	The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores.
disableLocalAuth	boolean	Disables all authentication methods other than AAD authentication.
enablePurgeProtection	boolean	Property specifying whether protection against purge is enabled for this configuration store.
encryption	object	The encryption settings of the configuration store.
endpoint	string	The DNS endpoint where the configuration store API will be available.
identity	object	The managed identity information, if configured.
location	string	The geo-location where the resource lives. Required.
managedOnBehalfOfConfiguration	object	Managed On Behalf Of Configuration.
privateEndpointConnections	array	The list of private endpoint connections that are set up for this resource.
provisioningState	string	The provisioning state of the configuration store. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
publicNetworkAccess	string	Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". (Enabled, Disabled, SecuredByPerimeter)
sku	object	The sku of the configuration store. Required.
softDeleteRetentionInDays	integer	The amount of time in days that the configuration store will be retained when it is soft deleted.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
telemetry	object	Property specifying the configuration of telemetry for this configuration store.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, config_store_name, subscription_id		Gets the properties of the specified configuration store.
get_deleted	select	location, config_store_name, subscription_id		Gets a deleted Azure app configuration store.
list_by_resource_group	select	resource_group_name, subscription_id	$skipToken	Lists the configuration stores for a given resource group.
list	select	subscription_id	$skipToken	Lists the configuration stores for a given subscription.
create	insert	resource_group_name, config_store_name, subscription_id, location, sku		Creates a configuration store with the specified parameters.
update	update	resource_group_name, config_store_name, subscription_id		Updates a configuration store with the specified parameters.
delete	delete	resource_group_name, config_store_name, subscription_id		Deletes a configuration store.
list_keys	exec	resource_group_name, config_store_name, subscription_id	$skipToken	Lists the access key for the specified configuration store.
list_deleted	exec	subscription_id		Gets information about the deleted configuration stores in a subscription.
regenerate_key	exec	resource_group_name, config_store_name, subscription_id		Regenerates an access key for the specified configuration store.
purge_deleted	exec	location, config_store_name, subscription_id		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
config_store_name	string	The name of the configuration store. Required.
location	string	The name of the Azure region. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$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. Default value is None.

SELECT examples

get

Gets the properties of the specified configuration store.

SELECT
id,
name,
azureFrontDoor,
createMode,
creationDate,
dataPlaneProxy,
defaultKeyValueRevisionRetentionPeriodInSeconds,
disableLocalAuth,
enablePurgeProtection,
encryption,
endpoint,
identity,
location,
managedOnBehalfOfConfiguration,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
softDeleteRetentionInDays,
systemData,
tags,
telemetry,
type
FROM azure.app_configuration.configuration_stores
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND config_store_name = '{{ config_store_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_deleted

Gets a deleted Azure app configuration store.

SELECT
id,
name,
configurationStoreId,
deletionDate,
location,
purgeProtectionEnabled,
scheduledPurgeDate,
systemData,
tags,
type
FROM azure.app_configuration.configuration_stores
WHERE location = '{{ location }}' -- required
AND config_store_name = '{{ config_store_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists the configuration stores for a given resource group.

SELECT
id,
name,
azureFrontDoor,
createMode,
creationDate,
dataPlaneProxy,
defaultKeyValueRevisionRetentionPeriodInSeconds,
disableLocalAuth,
enablePurgeProtection,
encryption,
endpoint,
identity,
location,
managedOnBehalfOfConfiguration,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
softDeleteRetentionInDays,
systemData,
tags,
telemetry,
type
FROM azure.app_configuration.configuration_stores
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
;

list

Lists the configuration stores for a given subscription.

SELECT
id,
name,
azureFrontDoor,
createMode,
creationDate,
dataPlaneProxy,
defaultKeyValueRevisionRetentionPeriodInSeconds,
disableLocalAuth,
enablePurgeProtection,
encryption,
endpoint,
identity,
location,
managedOnBehalfOfConfiguration,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
softDeleteRetentionInDays,
systemData,
tags,
telemetry,
type
FROM azure.app_configuration.configuration_stores
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create

Creates a configuration store with the specified parameters.

INSERT INTO azure.app_configuration.configuration_stores (
tags,
location,
properties,
identity,
sku,
resource_group_name,
config_store_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ sku }}' /* required */,
'{{ resource_group_name }}',
'{{ config_store_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: configuration_stores
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the configuration_stores resource.
  - name: config_store_name
    value: "{{ config_store_name }}"
    description: Required parameter for the configuration_stores resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the configuration_stores resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The properties of a configuration store.
    value:
      provisioningState: "{{ provisioningState }}"
      creationDate: "{{ creationDate }}"
      endpoint: "{{ endpoint }}"
      encryption:
        keyVaultProperties:
          keyIdentifier: "{{ keyIdentifier }}"
          identityClientId: "{{ identityClientId }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            provisioningState: "{{ provisioningState }}"
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      disableLocalAuth: {{ disableLocalAuth }}
      softDeleteRetentionInDays: {{ softDeleteRetentionInDays }}
      defaultKeyValueRevisionRetentionPeriodInSeconds: {{ defaultKeyValueRevisionRetentionPeriodInSeconds }}
      enablePurgeProtection: {{ enablePurgeProtection }}
      dataPlaneProxy:
        authenticationMode: "{{ authenticationMode }}"
        privateLinkDelegation: "{{ privateLinkDelegation }}"
      createMode: "{{ createMode }}"
      telemetry:
        resourceId: "{{ resourceId }}"
      managedOnBehalfOfConfiguration:
        moboBrokerResources:
          - id: "{{ id }}"
      azureFrontDoor:
        resourceId: "{{ resourceId }}"
  - name: identity
    description: |
      The managed identity information, if configured.
    value:
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
  - name: sku
    description: |
      The sku of the configuration store. Required.
    value:
      name: "{{ name }}"

UPDATE examples

update

Updates a configuration store with the specified parameters.

UPDATE azure.app_configuration.configuration_stores
SET 
properties = '{{ properties }}',
identity = '{{ identity }}',
sku = '{{ sku }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND config_store_name = '{{ config_store_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes a configuration store.

DELETE FROM azure.app_configuration.configuration_stores
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND config_store_name = '{{ config_store_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_keys

Lists the access key for the specified configuration store.

EXEC azure.app_configuration.configuration_stores.list_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@config_store_name='{{ config_store_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$skipToken='{{ $skipToken }}'
;

list_deleted

Gets information about the deleted configuration stores in a subscription.

EXEC azure.app_configuration.configuration_stores.list_deleted 
@subscription_id='{{ subscription_id }}' --required
;

regenerate_key

Regenerates an access key for the specified configuration store.

EXEC azure.app_configuration.configuration_stores.regenerate_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@config_store_name='{{ config_store_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"id": "{{ id }}"
}'
;

purge_deleted

Permanently deletes the specified configuration store.

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