Share via

az appconfig snapshot

  • Reference

Manage snapshots associated with an app configuration store.

Commands

Name Description Type Status
az appconfig snapshot archive

Archive a snapshot.

 Core GA
az appconfig snapshot create

Create an app configuration snapshot.

 Core GA
az appconfig snapshot list

List snapshots.

 Core GA
az appconfig snapshot recover

Recover an archived snapshot.

 Core GA
az appconfig snapshot show

Show all attributes of an app configuration snapshot.

 Core GA

az appconfig snapshot archive

Edit

Archive a snapshot.

az appconfig snapshot archive --snapshot-name
                              [--auth-mode {key, login}]
                              [--connection-string]
                              [--endpoint]
                              [--name]

Examples

Archive snapshot MySnapshot in configuration store MyAppConfiguration.

az appconfig snapshot archive -s MySnapshot -n MyAppConfiguration

Required Parameters

--snapshot-name -s

Name of the App Configuration snapshot.

Optional Parameters

--auth-mode

This parameter can be used for indicating how a data operation is to be authorized. If the auth mode is "key", provide connection string or store name and your account access keys will be retrieved for authorization. If the auth mode is "login", provide the --endpoint or --name and your "az login" credentials will be used for authorization. You can configure the default auth mode using az configure --defaults appconfig_auth_mode=<auth_mode>. For more information, see https://docs.microsoft.com/azure/azure-app-configuration/concept-enable-rbac.

Accepted values: key, login
Default value: key
--connection-string

Combination of access key and endpoint of the App Configuration store. Can be found using 'az appconfig credential list'. Users can preset it using az configure --defaults appconfig_connection_string=<connection_string> or environment variable with the name AZURE_APPCONFIG_CONNECTION_STRING.

--endpoint

If auth mode is "login", provide endpoint URL of the App Configuration store. The endpoint can be retrieved using "az appconfig show" command. You can configure the default endpoint using az configure --defaults appconfig_endpoint=<endpoint>.

--name -n

Name of the App Configuration store. You can configure the default name using az configure --defaults app_configuration_store=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az appconfig snapshot create

Edit

Create an app configuration snapshot.

az appconfig snapshot create --filters
                             --snapshot-name
                             [--auth-mode {key, login}]
                             [--composition-type {key, key_label}]
                             [--connection-string]
                             [--endpoint]
                             [--name]
                             [--retention-period]
                             [--tags]

Examples

Create a snapshot MySnapshot of all keys starting with 'Test' in configuration store MyAppConfiguration.

az appconfig snapshot create -s MySnapshot -n MyAppConfiguration --filters '{\"key\":\"Test*\"}'

Create a snapshot MySnapshot of all keys starting with 'abc' and a retention period of 1 hour.

az appconfig snapshot create -s MySnapshot -n MyAppConfiguration --filters '{\"key\":\"abc*\"}' --retention-period 3600

Create a snapshot of all keys starting with 'app/' and no label as default, then override the key-values with keys with the label 'prod' if they exist.

az appconfig snapshot create -s MySnapshot -n MyAppConfiguration --filters '{\"key\":\"app/*\"}' '{\"key\":\"app/*\", \"label\":\"prod\"}' --composition-type 'key'

Required Parameters

--filters

Space-separated list of escaped JSON objects that represent the key and label filters used to build an App Configuration snapshot.

--snapshot-name -s

Name of the App Configuration snapshot.

Optional Parameters

--auth-mode

This parameter can be used for indicating how a data operation is to be authorized. If the auth mode is "key", provide connection string or store name and your account access keys will be retrieved for authorization. If the auth mode is "login", provide the --endpoint or --name and your "az login" credentials will be used for authorization. You can configure the default auth mode using az configure --defaults appconfig_auth_mode=<auth_mode>. For more information, see https://docs.microsoft.com/azure/azure-app-configuration/concept-enable-rbac.

Accepted values: key, login
Default value: key
--composition-type

Composition type used in building App Configuration snapshots. If not specified, defaults to key.

Accepted values: key, key_label
--connection-string

Combination of access key and endpoint of the App Configuration store. Can be found using 'az appconfig credential list'. Users can preset it using az configure --defaults appconfig_connection_string=<connection_string> or environment variable with the name AZURE_APPCONFIG_CONNECTION_STRING.

--endpoint

If auth mode is "login", provide endpoint URL of the App Configuration store. The endpoint can be retrieved using "az appconfig show" command. You can configure the default endpoint using az configure --defaults appconfig_endpoint=<endpoint>.

--name -n

Name of the App Configuration store. You can configure the default name using az configure --defaults app_configuration_store=<name>.

--retention-period

Duration in seconds for which a snapshot can remain archived before expiry. A snapshot can be archived for a maximum of 7 days (604,800s) for free tier stores and 90 days (7,776,000s) for standard and premium tier stores. If specified, retention period must be at least 1 hour (3600s).

--tags

Space-separated tags: key[=value] [key[=value] ...].

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az appconfig snapshot list

Edit

List snapshots.

az appconfig snapshot list [--all]
                           [--auth-mode {key, login}]
                           [--connection-string]
                           [--endpoint]
                           [--fields {composition_type, created, etag, expires, filters, items_count, name, retention_period, size, status, tags}]
                           [--name]
                           [--snapshot-name]
                           [--status {archived, failed, provisioning, ready}]
                           [--top]

Examples

List all snapshots with names starting with the prefix 'abc'.

az appconfig snapshot list -s abc* -n MyAppConfiguration

List all archived snapshots.

az appconfig snapshot list --status archived -n MyAppConfiguration

List all provisioning snapshots with names starting with the prefix 'app'.

az appconfig snapshot list -s app* --status provisioning -n MyAppConfiguration

List all failed and provisioning snapshots.

az appconfig snapshot list --status failed provisioning -n MyAppConfiguration

Optional Parameters

--all

List all items.

--auth-mode

This parameter can be used for indicating how a data operation is to be authorized. If the auth mode is "key", provide connection string or store name and your account access keys will be retrieved for authorization. If the auth mode is "login", provide the --endpoint or --name and your "az login" credentials will be used for authorization. You can configure the default auth mode using az configure --defaults appconfig_auth_mode=<auth_mode>. For more information, see https://docs.microsoft.com/azure/azure-app-configuration/concept-enable-rbac.

Accepted values: key, login
Default value: key
--connection-string

Combination of access key and endpoint of the App Configuration store. Can be found using 'az appconfig credential list'. Users can preset it using az configure --defaults appconfig_connection_string=<connection_string> or environment variable with the name AZURE_APPCONFIG_CONNECTION_STRING.

--endpoint

If auth mode is "login", provide endpoint URL of the App Configuration store. The endpoint can be retrieved using "az appconfig show" command. You can configure the default endpoint using az configure --defaults appconfig_endpoint=<endpoint>.

--fields

Customize output fields for Snapshots.

Accepted values: composition_type, created, etag, expires, filters, items_count, name, retention_period, size, status, tags
--name -n

Name of the App Configuration store. You can configure the default name using az configure --defaults app_configuration_store=<name>.

--snapshot-name -s

If no name specified, return all snapshots by default. Support star sign as filters, for instance abc* means snapshots with abc as prefix to the name.

Default value: *
--status

Filter snapshots by their status. If no status specified, return all snapshots by default.

Accepted values: archived, failed, provisioning, ready
--top -t

Maximum number of items to return. Must be a positive integer. Default to 100.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az appconfig snapshot recover

Edit

Recover an archived snapshot.

az appconfig snapshot recover --snapshot-name
                              [--auth-mode {key, login}]
                              [--connection-string]
                              [--endpoint]
                              [--name]

Examples

Recover snapshot MySnapshot in configuration store MyAppConfiguration.

az appconfig snapshot recover -s MySnapshot -n MyAppConfiguration

Required Parameters

--snapshot-name -s

Name of the App Configuration snapshot.

Optional Parameters

--auth-mode

This parameter can be used for indicating how a data operation is to be authorized. If the auth mode is "key", provide connection string or store name and your account access keys will be retrieved for authorization. If the auth mode is "login", provide the --endpoint or --name and your "az login" credentials will be used for authorization. You can configure the default auth mode using az configure --defaults appconfig_auth_mode=<auth_mode>. For more information, see https://docs.microsoft.com/azure/azure-app-configuration/concept-enable-rbac.

Accepted values: key, login
Default value: key
--connection-string

Combination of access key and endpoint of the App Configuration store. Can be found using 'az appconfig credential list'. Users can preset it using az configure --defaults appconfig_connection_string=<connection_string> or environment variable with the name AZURE_APPCONFIG_CONNECTION_STRING.

--endpoint

If auth mode is "login", provide endpoint URL of the App Configuration store. The endpoint can be retrieved using "az appconfig show" command. You can configure the default endpoint using az configure --defaults appconfig_endpoint=<endpoint>.

--name -n

Name of the App Configuration store. You can configure the default name using az configure --defaults app_configuration_store=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az appconfig snapshot show

Edit

Show all attributes of an app configuration snapshot.

az appconfig snapshot show --snapshot-name
                           [--auth-mode {key, login}]
                           [--connection-string]
                           [--endpoint]
                           [--fields {composition_type, created, etag, expires, filters, items_count, name, retention_period, size, status, tags}]
                           [--name]

Examples

Show an app configuration snapshot with name MySnapshot in configuration store MyAppConfiguration.

az appconfig snapshot show -s MySnapshot -n MyAppConfiguration

Required Parameters

--snapshot-name -s

Name of the App Configuration snapshot.

Optional Parameters

--auth-mode

This parameter can be used for indicating how a data operation is to be authorized. If the auth mode is "key", provide connection string or store name and your account access keys will be retrieved for authorization. If the auth mode is "login", provide the --endpoint or --name and your "az login" credentials will be used for authorization. You can configure the default auth mode using az configure --defaults appconfig_auth_mode=<auth_mode>. For more information, see https://docs.microsoft.com/azure/azure-app-configuration/concept-enable-rbac.

Accepted values: key, login
Default value: key
--connection-string

Combination of access key and endpoint of the App Configuration store. Can be found using 'az appconfig credential list'. Users can preset it using az configure --defaults appconfig_connection_string=<connection_string> or environment variable with the name AZURE_APPCONFIG_CONNECTION_STRING.

--endpoint

If auth mode is "login", provide endpoint URL of the App Configuration store. The endpoint can be retrieved using "az appconfig show" command. You can configure the default endpoint using az configure --defaults appconfig_endpoint=<endpoint>.

--fields

Customize output fields for Snapshots.

Accepted values: composition_type, created, etag, expires, filters, items_count, name, retention_period, size, status, tags
--name -n

Name of the App Configuration store. You can configure the default name using az configure --defaults app_configuration_store=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.