az appconfig

Reference

Manage App Configurations.

Commands

Name	Description	Type	Status
az appconfig create	Create an App Configuration.	Core	GA
az appconfig credential	Manage credentials for App Configurations.	Core	GA
az appconfig credential list	List access keys of an App Configuration.	Core	GA
az appconfig credential regenerate	Regenerate an access key for an App Configuration.	Core	GA
az appconfig delete	Delete an App Configuration.	Core	GA
az appconfig feature	Manage feature flags stored in an App Configuration.	Core	GA
az appconfig feature delete	Delete feature flag.	Core	GA
az appconfig feature disable	Disable a feature flag to turn it OFF for use.	Core	GA
az appconfig feature enable	Enable a feature flag to turn it ON for use.	Core	GA
az appconfig feature filter	Manage filters associated with feature flags stored in an App Configuration.	Core	GA
az appconfig feature filter add	Add a filter to a feature flag.	Core	GA
az appconfig feature filter delete	Delete a filter from a feature flag.	Core	GA
az appconfig feature filter list	List all filters for a feature flag.	Core	GA
az appconfig feature filter show	Show filters of a feature flag.	Core	GA
az appconfig feature filter update	Update a filter in a feature flag.	Core	GA
az appconfig feature list	List feature flags.	Core	GA
az appconfig feature lock	Lock a feature flag to prohibit write operations.	Core	GA
az appconfig feature set	Set a feature flag.	Core	GA
az appconfig feature show	Show all attributes of a feature flag.	Core	GA
az appconfig feature unlock	Unlock a feature to gain write operations.	Core	GA
az appconfig identity	Managed identities for App Configurations.	Core	GA
az appconfig identity assign	Update managed identities for an App Configuration.	Core	GA
az appconfig identity remove	Remove managed identities for an App Configuration.	Core	GA
az appconfig identity show	Display managed identities for an App Configuration.	Core	GA
az appconfig kv	Manage key-values stored in an App Configuration.	Core	GA
az appconfig kv delete	Delete key-values.	Core	GA
az appconfig kv export	Export configurations to another place from your App Configuration.	Core	GA
az appconfig kv import	Import configurations into your App Configuration from another place.	Core	GA
az appconfig kv list	List key-values.	Core	GA
az appconfig kv lock	Lock a key-value to prohibit write operations.	Core	GA
az appconfig kv restore	Restore key-values.	Core	GA
az appconfig kv set	Set a key-value.	Core	GA
az appconfig kv set-keyvault	Set a keyvault reference.	Core	GA
az appconfig kv show	Show all attributes of a key-value.	Core	GA
az appconfig kv unlock	Unlock a key-value to gain write operations.	Core	GA
az appconfig list	Lists all App Configurations under the current subscription.	Core	GA
az appconfig list-deleted	List all deleted, but not yet purged App Configurations.	Core	GA
az appconfig purge	Permanently delete an App Configuration. Aka 'purge' the deleted App Configuration.	Core	GA
az appconfig recover	Recover a previously deleted, but not yet purged App Configuration.	Core	GA
az appconfig replica	Manage replicas of an App Configuration.	Core	GA
az appconfig replica create	Create a new replica of an App Configuration.	Core	GA
az appconfig replica delete	Delete a replica of an App Configuration.	Core	GA
az appconfig replica list	List replicas of an App Configuration.	Core	GA
az appconfig replica show	Show details of a replica of an App Configuration.	Core	GA
az appconfig revision	Manage revisions for key-values stored in an App Configuration.	Core	GA
az appconfig revision list	Lists revision history of key-values.	Core	GA
az appconfig show	Show properties of an App Configuration.	Core	GA
az appconfig show-deleted	Show properties of a deleted, but not yet purged App Configuration.	Core	GA
az appconfig snapshot	Manage snapshots associated with an app configuration store.	Core	GA
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 update	Update an App Configuration.	Core	GA

az appconfig create

Edit

Create an App Configuration.

az appconfig create --location
                    --name
                    --resource-group
                    [--assign-identity]
                    [--disable-local-auth {false, true}]
                    [--enable-public-network {false, true}]
                    [--enable-purge-protection {false, true}]
                    [--retention-days]
                    [--sku {Free, Standard}]
                    [--tags]

Examples

Create an App Configuration with name, location, sku, tags and resource group.

az appconfig create -g MyResourceGroup -n MyAppConfiguration -l westus --sku Standard --tags key1=value1 key2=value2

Create an App Configuration with name, location, sku and resource group with system assigned identity.

az appconfig create -g MyResourceGroup -n MyAppConfiguration -l westus --sku Standard --assign-identity

Create an App Configuration with name, location, sku and resource group with user assigned identity.

az appconfig create -g MyResourceGroup -n MyAppConfiguration -l westus --sku Standard --assign-identity /subscriptions/<SUBSCRIPTON ID>/resourcegroups/<RESOURCEGROUP>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUserAssignedIdentity

Create an App Configuration with name, location and resource group with public network access enabled and local auth disabled.

az appconfig create -g MyResourceGroup -n MyAppConfiguration -l westus --enable-public-network --disable-local-auth

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

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

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--assign-identity

Space-separated list of managed identities to be assigned. Use "[system]" to refer to system-assigned managed identity or a resource ID to refer to user-assigned managed identity. If this argument is provided without any value, system-assigned managed identity will be assigned by default. If this argument is not provided, no managed identities will be assigned to this App Configuration store.

--disable-local-auth

Disable all authentication methods other than AAD authentication.

accepted values: false, true

--enable-public-network -e

When true, requests coming from public networks have permission to access this store while private endpoint is enabled. When false, only requests made through Private Links can reach this store.

accepted values: false, true

--enable-purge-protection -p

Property specifying whether protection against purge is enabled for this App Configuration. Setting this property to true activates protection against purge for this App Configuration and its contents. Enabling this functionality is irreversible.

accepted values: false, true

--retention-days

Number of days to retain the soft delete enabled App Configuration after deleting. Must be a positive integer between 0 and 7.

--sku

The sku of App Configuration.

accepted values: Free, Standard

default value: Standard

--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 delete

Edit

Delete an App Configuration.

az appconfig delete --name
                    [--resource-group]
                    [--yes]

Examples

Delete an App Configuration under resource group

az appconfig delete -g MyResourceGroup -n MyAppConfiguration

Required Parameters

--name -n

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

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--yes -y

Do not prompt for confirmation.

default value: False

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 list

Edit

Lists all App Configurations under the current subscription.

az appconfig list [--resource-group]

Examples

List all App Configurations under a resource group

az appconfig list -g MyResourceGroup

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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 list-deleted

Edit

List all deleted, but not yet purged App Configurations.

az appconfig list-deleted

Examples

List all deleted, but not yet purged App Configurations.

az appconfig list-deleted

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 purge

Edit

Permanently delete an App Configuration. Aka 'purge' the deleted App Configuration.

az appconfig purge --name
                   [--location]
                   [--yes]

Examples

Purge a deleted App Configuration named 'sample-app-configuration'.

az appconfig purge --name sample-app-configuration

Required Parameters

--name -n

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

Optional Parameters

--location -l

Location of the deleted App Configuration. Can be viewed using command az appconfig show-deleted.

--yes -y

Do not prompt for confirmation.

default value: False

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 recover

Edit

Recover a previously deleted, but not yet purged App Configuration.

az appconfig recover --name
                     [--location]
                     [--resource-group]
                     [--yes]

Examples

Recover a deleted App Configuration named 'sample-app-configuration'.

az appconfig recover --name sample-app-configuration

Required Parameters

--name -n

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

Optional Parameters

--location -l

Location of the deleted App Configuration. Can be viewed using command az appconfig show-deleted.

--resource-group -g

Resource group of the deleted App Configuration.

--yes -y

Do not prompt for confirmation.

default value: False

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 show

Edit

Show properties of an App Configuration.

az appconfig show --name
                  [--resource-group]

Examples

Show properties of an App Configuration

az appconfig show -g MyResourceGroup -n MyAppConfiguration

Required Parameters

--name -n

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

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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 show-deleted

Edit

Show properties of a deleted, but not yet purged App Configuration.

az appconfig show-deleted --name
                          [--location]

Examples

Show properties of a deleted App Configuration named 'sample-app-configuration'.

az appconfig show-deleted --name sample-app-configuration

Required Parameters

--name -n

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

Optional Parameters

--location -l

Location of the deleted App Configuration.

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 update

Edit

Update an App Configuration.

az appconfig update --name
                    [--disable-local-auth {false, true}]
                    [--enable-public-network {false, true}]
                    [--enable-purge-protection {false, true}]
                    [--encryption-key-name]
                    [--encryption-key-vault]
                    [--encryption-key-version]
                    [--identity-client-id]
                    [--resource-group]
                    [--sku {Free, Standard}]
                    [--tags]

Examples

Update tags of an App Configuration

az appconfig update -g MyResourceGroup -n MyAppConfiguration --tags key1=value1 key2=value2

Upgrade sku of an App Configuration to standard

az appconfig update -g MyResourceGroup -n MyAppConfiguration --sku Standard

Enable customer encryption key with system assigned identity

az appconfig update -g MyResourceGroup -n MyAppConfiguration --encryption-key-name myKey --encryption-key-version keyVersion --encryption-key-vault https://keyVaultName.vault.azure.net

Remove customer encryption key

az appconfig update -g MyResourceGroup -n MyAppConfiguration --encryption-key-name ""

Update an App Configuration to enable public network access and disable local auth.

az appconfig update -g MyResourceGroup -n MyAppConfiguration --enable-public-network true --disable-local-auth true

Required Parameters

--name -n

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

Optional Parameters

--disable-local-auth

Disable all authentication methods other than AAD authentication.

accepted values: false, true

--enable-public-network -e

When true, requests coming from public networks have permission to access this store while private endpoint is enabled. When false, only requests made through Private Links can reach this store.

accepted values: false, true

--enable-purge-protection -p

accepted values: false, true

--encryption-key-name

The name of the KeyVault key.

--encryption-key-vault

The URI of the KeyVault.

--encryption-key-version

The version of the KeyVault key. Use the latest version by default.

--identity-client-id

Client ID of the managed identity with wrap and unwrap access to encryption key. Use system-assigned managed identity by default.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--sku

The sku of App Configuration.

accepted values: Free, Standard

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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

Commands

az appconfig create

Examples

Required Parameters

Optional Parameters

az appconfig delete

Examples

Required Parameters

Optional Parameters

az appconfig list

Examples

Optional Parameters

az appconfig list-deleted

Examples

az appconfig purge

Examples

Required Parameters

Optional Parameters

az appconfig recover

Examples

Required Parameters

Optional Parameters

az appconfig show

Examples

Required Parameters

Optional Parameters

az appconfig show-deleted

Examples

Required Parameters

Optional Parameters

az appconfig update

Examples

Required Parameters

Optional Parameters

Feedback

Additional resources