Microsoft.AppConfiguration configurationStores

Bicep resource definition

The configurationStores resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AppConfiguration/configurationStores resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AppConfiguration/configurationStores@2023-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    createMode: 'string'
    disableLocalAuth: bool
    enablePurgeProtection: bool
    encryption: {
      keyVaultProperties: {
        identityClientId: 'string'
        keyIdentifier: 'string'
      }
    }
    publicNetworkAccess: 'string'
    softDeleteRetentionInDays: int
  }
}

Property values

configurationStores

Name Description Value
name The resource name string (required)

Character limit: 5-50

Valid characters:
Alphanumerics, underscores, and hyphens.
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The sku of the configuration store. Sku (required)
identity The managed identity information, if configured. ResourceIdentity
properties The properties of a configuration store. ConfigurationStoreProperties

ResourceIdentity

Name Description Value
type The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. object

ConfigurationStoreProperties

Name Description Value
createMode Indicates whether the configuration store need to be recovered. 'Default'
'Recover'
disableLocalAuth Disables all authentication methods other than AAD authentication. bool
enablePurgeProtection Property specifying whether protection against purge is enabled for this configuration store. bool
encryption The encryption settings of the configuration store. EncryptionProperties
publicNetworkAccess Control permission for data plane traffic coming from public networks while private endpoint is enabled. 'Disabled'
'Enabled'
softDeleteRetentionInDays The amount of time in days that the configuration store will be retained when it is soft deleted. int

EncryptionProperties

Name Description Value
keyVaultProperties Key vault properties. KeyVaultProperties

KeyVaultProperties

Name Description Value
identityClientId The client id of the identity which will be used to access key vault. string
keyIdentifier The URI of the key vault key used to encrypt data. string

Sku

Name Description Value
name The SKU name of the configuration store. string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
App Configuration with VM

Deploy to Azure
This template references existing key-value configurations from an existing config store and uses retrieved values to set properties of the resources the template creates.
Create an App Configuration Store

Deploy to Azure
This template creates an Azure App Configuration store.
Create an App Configuration Store with Feature Flag

Deploy to Azure
This template creates a new Azure App Configuration store with one feature flag.
Create an App Configuration Store with Feature Flag

Deploy to Azure
This template creates a new Azure App Configuration store with one Key Vault reference.
Create an App Configuration Store with Outputs

Deploy to Azure
This template creates a new Azure App Configuration store with two key-values.
App Configuration Key-Values

Deploy to Azure
This template creates a new Azure App Configuration store with three key-values controlled by a copy function.

ARM template resource definition

The configurationStores resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AppConfiguration/configurationStores resource, add the following JSON to your template.

{
  "type": "Microsoft.AppConfiguration/configurationStores",
  "apiVersion": "2023-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "createMode": "string",
    "disableLocalAuth": "bool",
    "enablePurgeProtection": "bool",
    "encryption": {
      "keyVaultProperties": {
        "identityClientId": "string",
        "keyIdentifier": "string"
      }
    },
    "publicNetworkAccess": "string",
    "softDeleteRetentionInDays": "int"
  }
}

Property values

configurationStores

Name Description Value
type The resource type 'Microsoft.AppConfiguration/configurationStores'
apiVersion The resource api version '2023-03-01'
name The resource name string (required)

Character limit: 5-50

Valid characters:
Alphanumerics, underscores, and hyphens.
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The sku of the configuration store. Sku (required)
identity The managed identity information, if configured. ResourceIdentity
properties The properties of a configuration store. ConfigurationStoreProperties

ResourceIdentity

Name Description Value
type The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. object

ConfigurationStoreProperties

Name Description Value
createMode Indicates whether the configuration store need to be recovered. 'Default'
'Recover'
disableLocalAuth Disables all authentication methods other than AAD authentication. bool
enablePurgeProtection Property specifying whether protection against purge is enabled for this configuration store. bool
encryption The encryption settings of the configuration store. EncryptionProperties
publicNetworkAccess Control permission for data plane traffic coming from public networks while private endpoint is enabled. 'Disabled'
'Enabled'
softDeleteRetentionInDays The amount of time in days that the configuration store will be retained when it is soft deleted. int

EncryptionProperties

Name Description Value
keyVaultProperties Key vault properties. KeyVaultProperties

KeyVaultProperties

Name Description Value
identityClientId The client id of the identity which will be used to access key vault. string
keyIdentifier The URI of the key vault key used to encrypt data. string

Sku

Name Description Value
name The SKU name of the configuration store. string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
App Configuration with VM

Deploy to Azure
This template references existing key-value configurations from an existing config store and uses retrieved values to set properties of the resources the template creates.
Create an App Configuration Store

Deploy to Azure
This template creates an Azure App Configuration store.
Create an App Configuration Store with Feature Flag

Deploy to Azure
This template creates a new Azure App Configuration store with one feature flag.
Create an App Configuration Store with Feature Flag

Deploy to Azure
This template creates a new Azure App Configuration store with one Key Vault reference.
Create an App Configuration Store with Outputs

Deploy to Azure
This template creates a new Azure App Configuration store with two key-values.
App Configuration Key-Values

Deploy to Azure
This template creates a new Azure App Configuration store with three key-values controlled by a copy function.

Terraform (AzAPI provider) resource definition

The configurationStores resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AppConfiguration/configurationStores resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppConfiguration/configurationStores@2023-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      createMode = "string"
      disableLocalAuth = bool
      enablePurgeProtection = bool
      encryption = {
        keyVaultProperties = {
          identityClientId = "string"
          keyIdentifier = "string"
        }
      }
      publicNetworkAccess = "string"
      softDeleteRetentionInDays = int
    }
    sku = {
      name = "string"
    }
  })
}

Property values

configurationStores

Name Description Value
type The resource type "Microsoft.AppConfiguration/configurationStores@2023-03-01"
name The resource name string (required)

Character limit: 5-50

Valid characters:
Alphanumerics, underscores, and hyphens.
location The geo-location where the resource lives string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
sku The sku of the configuration store. Sku (required)
identity The managed identity information, if configured. ResourceIdentity
properties The properties of a configuration store. ConfigurationStoreProperties

ResourceIdentity

Name Description Value
type The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. "SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
identity_ids The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Array of user identity IDs.

ConfigurationStoreProperties

Name Description Value
createMode Indicates whether the configuration store need to be recovered. "Default"
"Recover"
disableLocalAuth Disables all authentication methods other than AAD authentication. bool
enablePurgeProtection Property specifying whether protection against purge is enabled for this configuration store. bool
encryption The encryption settings of the configuration store. EncryptionProperties
publicNetworkAccess Control permission for data plane traffic coming from public networks while private endpoint is enabled. "Disabled"
"Enabled"
softDeleteRetentionInDays The amount of time in days that the configuration store will be retained when it is soft deleted. int

EncryptionProperties

Name Description Value
keyVaultProperties Key vault properties. KeyVaultProperties

KeyVaultProperties

Name Description Value
identityClientId The client id of the identity which will be used to access key vault. string
keyIdentifier The URI of the key vault key used to encrypt data. string

Sku

Name Description Value
name The SKU name of the configuration store. string (required)