Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The configurationStores/snapshots 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/snapshots resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AppConfiguration/configurationStores/snapshots@2025-08-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
compositionType: 'string'
filters: [
{
key: 'string'
label: 'string'
}
]
retentionPeriod: int
tags: {
{customized property}: 'string'
}
}
}
Property Values
Microsoft.AppConfiguration/configurationStores/snapshots
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[^\x00-\x1F\x7F]+$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: configurationStores |
| properties | All snapshot properties. | SnapshotProperties (required) |
KeyValueFilter
| Name | Description | Value |
|---|---|---|
| key | Filters key-values by their key field. | string (required) |
| label | Filters key-values by their label field. | string |
SnapshotProperties
| Name | Description | Value |
|---|---|---|
| compositionType | The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. | 'Key' 'Key_Label' |
| filters | A list of filters used to filter the key-values included in the snapshot. | KeyValueFilter[] (required) |
| retentionPeriod | The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used. | int Constraints: Min value = 3600 Max value = 7776000 |
| tags | The tags of the snapshot. NOTE: These are data plane tags, not ARM tags. | SnapshotPropertiesTags |
SnapshotPropertiesTags
| Name | Description | Value |
|---|
ARM template resource definition
The configurationStores/snapshots 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.
Usage Examples
Resource format
To create a Microsoft.AppConfiguration/configurationStores/snapshots resource, add the following JSON to your template.
{
"type": "Microsoft.AppConfiguration/configurationStores/snapshots",
"apiVersion": "2025-08-01-preview",
"name": "string",
"properties": {
"compositionType": "string",
"filters": [
{
"key": "string",
"label": "string"
}
],
"retentionPeriod": "int",
"tags": {
"{customized property}": "string"
}
}
}
Property Values
Microsoft.AppConfiguration/configurationStores/snapshots
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-08-01-preview' |
| name | The resource name | string Constraints: Pattern = ^[^\x00-\x1F\x7F]+$ (required) |
| properties | All snapshot properties. | SnapshotProperties (required) |
| type | The resource type | 'Microsoft.AppConfiguration/configurationStores/snapshots' |
KeyValueFilter
| Name | Description | Value |
|---|---|---|
| key | Filters key-values by their key field. | string (required) |
| label | Filters key-values by their label field. | string |
SnapshotProperties
| Name | Description | Value |
|---|---|---|
| compositionType | The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. | 'Key' 'Key_Label' |
| filters | A list of filters used to filter the key-values included in the snapshot. | KeyValueFilter[] (required) |
| retentionPeriod | The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used. | int Constraints: Min value = 3600 Max value = 7776000 |
| tags | The tags of the snapshot. NOTE: These are data plane tags, not ARM tags. | SnapshotPropertiesTags |
SnapshotPropertiesTags
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The configurationStores/snapshots 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/snapshots resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AppConfiguration/configurationStores/snapshots@2025-08-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
compositionType = "string"
filters = [
{
key = "string"
label = "string"
}
]
retentionPeriod = int
tags = {
{customized property} = "string"
}
}
}
}
Property Values
Microsoft.AppConfiguration/configurationStores/snapshots
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[^\x00-\x1F\x7F]+$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: configurationStores |
| properties | All snapshot properties. | SnapshotProperties (required) |
| type | The resource type | "Microsoft.AppConfiguration/configurationStores/snapshots@2025-08-01-preview" |
KeyValueFilter
| Name | Description | Value |
|---|---|---|
| key | Filters key-values by their key field. | string (required) |
| label | Filters key-values by their label field. | string |
SnapshotProperties
| Name | Description | Value |
|---|---|---|
| compositionType | The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. | 'Key' 'Key_Label' |
| filters | A list of filters used to filter the key-values included in the snapshot. | KeyValueFilter[] (required) |
| retentionPeriod | The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used. | int Constraints: Min value = 3600 Max value = 7776000 |
| tags | The tags of the snapshot. NOTE: These are data plane tags, not ARM tags. | SnapshotPropertiesTags |
SnapshotPropertiesTags
| Name | Description | Value |
|---|