az appconfig feature

Manage feature flags stored in an App Configuration.

Commands

az appconfig feature delete

Delete feature flag.

az appconfig feature disable

Disable a feature flag to turn it OFF for use.

az appconfig feature enable

Enable a feature flag to turn it ON for use.

az appconfig feature filter

Manage filters associated with feature flags stored in an App Configuration.

az appconfig feature filter add

Add a filter to a feature flag.

az appconfig feature filter delete

Delete a filter from a feature flag.

az appconfig feature filter list

List all filters for a feature flag.

az appconfig feature filter show

Show filters of a feature flag.

az appconfig feature list

List feature flags.

az appconfig feature lock

Lock a feature flag to prohibit write operations.

az appconfig feature set

Set a feature flag.

az appconfig feature show

Show all attributes of a feature flag.

az appconfig feature unlock

Unlock a feature to gain write operations.

az appconfig feature delete

Delete feature flag.

az appconfig feature delete --feature
                            [--connection-string]
                            [--label]
                            [--name]
                            [--subscription]
                            [--yes]

Examples

Delete a feature using App Configuration name without confirmation.

az appconfig feature delete -n MyAppConfiguration --feature color --label MyLabel --yes

Delete a feature using connection string.

az appconfig feature delete --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx --feature color --label MyLabel

Required Parameters

--feature

Key of the feature to be deleted. Support star sign as filters, for instance * means all key and abc* means keys with abc as prefix. Comma separated keys are not supported. Please provide escaped string if your feature name contains comma.

Optional Parameters

--connection-string

Combination of access key and endpoint of App Configuration. 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.

--label

If no label specified, delete the feature flag with null label by default. Support star sign as filters, for instance * means all labels and abc* means labels with abc as prefix.

--name -n

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

--subscription

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

--yes -y

Do not prompt for confirmation.

az appconfig feature disable

Disable a feature flag to turn it OFF for use.

az appconfig feature disable --feature
                             [--connection-string]
                             [--label]
                             [--name]
                             [--subscription]
                             [--yes]

Examples

disable a feature using App Configuration name.

az appconfig feature disable -n MyAppConfiguration --feature color --label test

Force disabling a feature using connection string.

az appconfig feature disable --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx --feature color --label test --yes

Required Parameters

--feature

Key of the feature to be disabled.

Optional Parameters

--connection-string

Combination of access key and endpoint of App Configuration. 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.

--label

If no label specified, disable the feature flag with null label by default.

--name -n

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

--subscription

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

--yes -y

Do not prompt for confirmation.

az appconfig feature enable

Enable a feature flag to turn it ON for use.

az appconfig feature enable --feature
                            [--connection-string]
                            [--label]
                            [--name]
                            [--subscription]
                            [--yes]

Examples

enable a feature using App Configuration name.

az appconfig feature enable -n MyAppConfiguration --feature color --label test

Force enabling a feature using connection string.

az appconfig feature enable --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx --feature color --label test --yes

Required Parameters

--feature

Key of the feature to be enabled.

Optional Parameters

--connection-string

Combination of access key and endpoint of App Configuration. 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.

--label

If no label specified, enable the feature flag with null label by default.

--name -n

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

--subscription

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

--yes -y

Do not prompt for confirmation.

az appconfig feature list

List feature flags.

az appconfig feature list [--all]
                          [--connection-string]
                          [--feature]
                          [--fields {conditions, description, key, label, last_modified, locked, state}]
                          [--label]
                          [--name]
                          [--query-examples]
                          [--subscription]
                          [--top]

Examples

List all feature flags.

az appconfig feature list -n MyAppConfiguration

List all feature flags with null labels.

az appconfig feature list -n MyAppConfiguration --label \0

List a specfic feature for any label start with v1. using connection string.

az appconfig feature list --feature color --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx --label v1.*

List all features with any labels and query only key, state and conditions.

az appconfig feature list --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx --fields key state conditions

List 150 feature flags with any labels.

az appconfig feature list --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx  --top 150

List feature flags with multiple labels.

az appconfig feature list --label test,prod,\0 -n MyAppConfiguration

Optional Parameters

--all

List all feature flags.

--connection-string

Combination of access key and endpoint of App Configuration. 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.

--feature

Key of the feature to be listed. Support star sign as filters, for instance * means all key and abc* means keys with abc as prefix. Comma separated keys are not supported. Please provide escaped string if your feature name contains comma.

--fields

Customize output fields for Feature Flags.

accepted values: conditions, description, key, label, last_modified, locked, state
--label

If no label specified, list all labels. Support star sign as filters, for instance * means all labels and abc* means labels with abc as prefix. Use '0' for null label.

--name -n

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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

--top -t

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

az appconfig feature lock

Lock a feature flag to prohibit write operations.

az appconfig feature lock --feature
                          [--connection-string]
                          [--label]
                          [--name]
                          [--subscription]
                          [--yes]

Examples

Lock a feature using App Configuration name.

az appconfig feature lock -n MyAppConfiguration --feature color --label test

Force locking a feature using connection string.

az appconfig feature lock --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx --feature color --label test --yes

Required Parameters

--feature

Key of the feature to be locked.

Optional Parameters

--connection-string

Combination of access key and endpoint of App Configuration. 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.

--label

If no label specified, lock the feature flag with null label by default.

--name -n

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

--subscription

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

--yes -y

Do not prompt for confirmation.

az appconfig feature set

Set a feature flag.

az appconfig feature set --feature
                         [--connection-string]
                         [--description]
                         [--label]
                         [--name]
                         [--subscription]
                         [--yes]

Examples

Set a feature flag with label MyLabel.

az appconfig feature set -n MyAppConfiguration --feature color --label MyLabel

Set a feature flag with null label using connection string and set a description.

az appconfig feature set --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx --feature color --description "This is a colorful feature"

Required Parameters

--feature

Name of the feature flag to be set. Only alphanumeric characters, '.', '-' and '_' are allowed.

Optional Parameters

--connection-string

Combination of access key and endpoint of App Configuration. 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.

--description

Description of the feature flag to be set.

--label

If no label specified, set the feature flag with null label by default.

--name -n

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

--subscription

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

--yes -y

Do not prompt for confirmation.

az appconfig feature show

Show all attributes of a feature flag.

az appconfig feature show --feature
                          [--connection-string]
                          [--fields {conditions, description, key, label, last_modified, locked, state}]
                          [--label]
                          [--name]
                          [--query-examples]
                          [--subscription]

Examples

Show a feature flag using App Configuration name with a specific label

az appconfig feature show -n MyAppConfiguration --feature color --label MyLabel

Show a feature flag using connection string and field filters

az appconfig feature show --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx --feature color --fields key locked conditions state

Required Parameters

--feature

Name of the feature flag to be retrieved.

Optional Parameters

--connection-string

Combination of access key and endpoint of App Configuration. 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.

--fields

Customize output fields for Feature Flags.

accepted values: conditions, description, key, label, last_modified, locked, state
--label

If no label specified, show entry with null label. Filtering is not supported.

--name -n

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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az appconfig feature unlock

Unlock a feature to gain write operations.

az appconfig feature unlock --feature
                            [--connection-string]
                            [--label]
                            [--name]
                            [--subscription]
                            [--yes]

Examples

Unlock a feature using App Configuration name.

az appconfig feature unlock -n MyAppConfiguration --feature color --label test

Force unlocking a feature using connection string.

az appconfig feature unlock --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx --feature color --label test --yes

Required Parameters

--feature

Key of the feature to be unlocked.

Optional Parameters

--connection-string

Combination of access key and endpoint of App Configuration. 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.

--label

If no label specified, unlock the feature flag with null label by default.

--name -n

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

--subscription

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

--yes -y

Do not prompt for confirmation.