Microsoft.AppConfiguration configurationStores 2023-08-01-preview
Bicep resource definition
The configurationStores resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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-08-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
createMode: 'string'
dataPlaneProxy: {
authenticationMode: 'string'
privateLinkDelegation: 'string'
}
disableLocalAuth: bool
enablePurgeProtection: bool
encryption: {
keyVaultProperties: {
identityClientId: 'string'
keyIdentifier: 'string'
}
}
publicNetworkAccess: 'string'
softDeleteRetentionInDays: int
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property values
ConfigurationStoreProperties
| Name | Description | Value |
|---|---|---|
| createMode | Indicates whether the configuration store need to be recovered. | 'Default' 'Recover' |
| dataPlaneProxy | Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). | DataPlaneProxyProperties |
| 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 |
DataPlaneProxyProperties
| Name | Description | Value |
|---|---|---|
| authenticationMode | The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. | 'Local' 'Pass-through' |
| privateLinkDelegation | The data plane proxy private link delegation. This property manages if a request from delegated ARM private link is allowed when the data plane resource requires private link. | 'Disabled' 'Enabled' |
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 |
Microsoft.AppConfiguration/configurationStores
| Name | Description | Value |
|---|---|---|
| identity | The managed identity information, if configured. | ResourceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 5 Max length = 5 Pattern = ^[a-zA-Z0-9_-]*$ (required) |
| properties | The properties of a configuration store. | ConfigurationStoreProperties |
| sku | The sku of the configuration store. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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}'. | ResourceIdentityUserAssignedIdentities |
ResourceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
Sku
| Name | Description | Value |
|---|---|---|
| name | The SKU name of the configuration store. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserIdentity
| Name | Description | Value |
|---|
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| Create an App Configuration Store | This template creates an Azure App Configuration store. |
| Create an App Configuration Store with Feature Flag | This template creates a new Azure App Configuration store with one feature flag. |
| Create an App Configuration Store with Feature Flag | This template creates a new Azure App Configuration store with one Key Vault reference. |
| Create an App Configuration Store with Outputs | This template creates a new Azure App Configuration store with two key-values. |
ARM template resource definition
The configurationStores resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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-08-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"createMode": "string",
"dataPlaneProxy": {
"authenticationMode": "string",
"privateLinkDelegation": "string"
},
"disableLocalAuth": "bool",
"enablePurgeProtection": "bool",
"encryption": {
"keyVaultProperties": {
"identityClientId": "string",
"keyIdentifier": "string"
}
},
"publicNetworkAccess": "string",
"softDeleteRetentionInDays": "int"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property values
ConfigurationStoreProperties
| Name | Description | Value |
|---|---|---|
| createMode | Indicates whether the configuration store need to be recovered. | 'Default' 'Recover' |
| dataPlaneProxy | Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). | DataPlaneProxyProperties |
| 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 |
DataPlaneProxyProperties
| Name | Description | Value |
|---|---|---|
| authenticationMode | The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. | 'Local' 'Pass-through' |
| privateLinkDelegation | The data plane proxy private link delegation. This property manages if a request from delegated ARM private link is allowed when the data plane resource requires private link. | 'Disabled' 'Enabled' |
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 |
Microsoft.AppConfiguration/configurationStores
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-08-01-preview' |
| identity | The managed identity information, if configured. | ResourceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 5 Max length = 5 Pattern = ^[a-zA-Z0-9_-]*$ (required) |
| properties | The properties of a configuration store. | ConfigurationStoreProperties |
| sku | The sku of the configuration store. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.AppConfiguration/configurationStores' |
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}'. | ResourceIdentityUserAssignedIdentities |
ResourceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
Sku
| Name | Description | Value |
|---|---|---|
| name | The SKU name of the configuration store. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserIdentity
| Name | Description | Value |
|---|
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
App Configuration Key-Values |
This template creates a new Azure App Configuration store with three key-values controlled by a copy function. |
| App Configuration with VM |
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 |
This template creates an Azure App Configuration store. |
| Create an App Configuration Store with Feature Flag |
This template creates a new Azure App Configuration store with one feature flag. |
| Create an App Configuration Store with Feature Flag |
This template creates a new Azure App Configuration store with one Key Vault reference. |
| Create an App Configuration Store with Outputs |
This template creates a new Azure App Configuration store with two key-values. |
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-08-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
sku = {
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
createMode = "string"
dataPlaneProxy = {
authenticationMode = "string"
privateLinkDelegation = "string"
}
disableLocalAuth = bool
enablePurgeProtection = bool
encryption = {
keyVaultProperties = {
identityClientId = "string"
keyIdentifier = "string"
}
}
publicNetworkAccess = "string"
softDeleteRetentionInDays = int
}
})
}
Property values
ConfigurationStoreProperties
| Name | Description | Value |
|---|---|---|
| createMode | Indicates whether the configuration store need to be recovered. | 'Default' 'Recover' |
| dataPlaneProxy | Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). | DataPlaneProxyProperties |
| 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 |
DataPlaneProxyProperties
| Name | Description | Value |
|---|---|---|
| authenticationMode | The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. | 'Local' 'Pass-through' |
| privateLinkDelegation | The data plane proxy private link delegation. This property manages if a request from delegated ARM private link is allowed when the data plane resource requires private link. | 'Disabled' 'Enabled' |
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 |
Microsoft.AppConfiguration/configurationStores
| Name | Description | Value |
|---|---|---|
| identity | The managed identity information, if configured. | ResourceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 5 Max length = 5 Pattern = ^[a-zA-Z0-9_-]*$ (required) |
| properties | The properties of a configuration store. | ConfigurationStoreProperties |
| sku | The sku of the configuration store. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.AppConfiguration/configurationStores@2023-08-01-preview" |
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}'. | ResourceIdentityUserAssignedIdentities |
ResourceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
Sku
| Name | Description | Value |
|---|---|---|
| name | The SKU name of the configuration store. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserIdentity
| Name | Description | Value |
|---|