az appconfig feature filter

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

Commands

Name	Description	Type	Status
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 filter add

Add a filter to a feature flag.

az appconfig feature filter add --filter-name
                                [--auth-mode {key, login}]
                                [--connection-string]
                                [--endpoint]
                                [--feature]
                                [--filter-parameters]
                                [--index]
                                [--key]
                                [--label]
                                [--name]
                                [--yes]

Examples

Add a filter for feature 'color' with label MyLabel with name 'MyFilter' and 2 parameters.

az appconfig feature filter add -n MyAppConfiguration --feature color --label MyLabel --filter-name MyFilter --filter-parameters Name=\"Value\" Name2=\"Value2\"

Insert a filter at index 2 (zero-based index) for feature 'color' with label MyLabel and filter name 'MyFilter' with no parameters

az appconfig feature filter add -n MyAppConfiguration --feature color --label MyLabel --filter-name MyFilter --index 2

Add a filter with name 'MyFilter' using connection string.

az appconfig feature filter add --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx --feature color --filter-name MyFilter

Add a filter with name 'MyFilter' using App Configuration endpoint and your 'az login' credentials.

az appconfig feature filter add --endpoint=https://contoso.azconfig.io --feature color --filter-name MyFilter --auth-mode login

Add a filter for feature 'color' with label MyLabel with name 'MyFilter' and array parameters.

az appconfig feature filter add -n MyAppConfiguration --feature color --label MyLabel --filter-name MyFilter --filter-parameters ArrayParam=[1,2,3]

Required Parameters

--filter-name

Name of the filter to be added.

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 store endpoint or store 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 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.

--endpoint

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

--feature

Name of the feature to which you want to add the filter. If the feature flag key is different from the default key, provide the --key argument instead.

--filter-parameters

Space-separated filter parameters in 'name[=value]' format. The value must be an escaped JSON string.

--index

Zero-based index in the list of filters where you want to insert the new filter. If no index is specified or index is invalid, filter will be added to the end of the list.

--key

Key of the feature flag. Key must start with the ".appconfig.featureflag/" prefix. Key cannot contain the "%" character. If both key and feature arguments are provided, only key will be used. Default key is the reserved prefix ".appconfig.featureflag/" + feature name.

--label

If no label specified, add to 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>.

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

Delete a filter from a feature flag.

az appconfig feature filter delete [--all]
                                   [--auth-mode {key, login}]
                                   [--connection-string]
                                   [--endpoint]
                                   [--feature]
                                   [--filter-name]
                                   [--index]
                                   [--key]
                                   [--label]
                                   [--name]
                                   [--yes]

Examples

Delete a filter from a feature using App Configuration name without confirmation.

az appconfig feature filter delete -n MyAppConfiguration --feature color --filter-name MyFilter --yes

Delete a filter from a feature when you have multiple filters with that same name.

az appconfig feature filter delete --feature color --filter-name MyFilter --index 2 --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx

Delete all filters of a feature using App Configuration name without confirmation.

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

Optional Parameters

--all

Delete all filters associated with a feature flag.

default value: False

--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 store endpoint or store 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 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.

--endpoint

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

--feature

Name of the feature from which you want to delete the filter. If the feature flag key is different from the default key, provide the --key argument instead.

--filter-name

Name of the filter to be deleted.

--index

Zero-based index of the filter to be deleted in case there are multiple instances with same filter name.

--key

Key of the feature flag. Key must start with the ".appconfig.featureflag/" prefix. Key cannot contain the "%" character. If both key and feature arguments are provided, only key will be used. Default key is the reserved prefix ".appconfig.featureflag/" + feature name.

--label

If no label specified, delete from 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>.

--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 feature filter list

List all filters for a feature flag.

az appconfig feature filter list [--all]
                                 [--auth-mode {key, login}]
                                 [--connection-string]
                                 [--endpoint]
                                 [--feature]
                                 [--key]
                                 [--label]
                                 [--name]
                                 [--top]

Examples

List all filters for feature flag 'color'.

az appconfig feature filter list -n MyAppConfiguration --feature color --all

List 150 filters for feature flag 'color'

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

List all filters for feature flag 'color' using your 'az login' credentials.

az appconfig feature filter list --endpoint https://myappconfiguration.azconfig.io --feature color --all --auth-mode login

Optional Parameters

--all

List all filters associated with a feature flag.

default value: False

--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 store endpoint or store 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 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.

--endpoint

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

--feature

Name of the feature whose filters you want to be displayed. If the feature flag key is different from the default key, provide the --key argument instead.

--key

Key of the feature flag. Key must start with the ".appconfig.featureflag/" prefix. Key cannot contain the "%" character. If both key and feature arguments are provided, only key will be used. Default key is the reserved prefix ".appconfig.featureflag/" + feature name.

--label

If no label specified, display filters from 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>.

--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 feature filter show

Show filters of a feature flag.

az appconfig feature filter show --filter-name
                                 [--auth-mode {key, login}]
                                 [--connection-string]
                                 [--endpoint]
                                 [--feature]
                                 [--index]
                                 [--key]
                                 [--label]
                                 [--name]

Examples

Show one unique feature filter when you have multiple filters with that same name.

az appconfig feature filter show -n MyAppConfiguration --feature color --filter-name MyFilter --index 2

Show all instances of a feature filter when you have multiple filters with that same name.

az appconfig feature filter show --connection-string Endpoint=https://contoso.azconfig.io;Id=xxx;Secret=xxx --feature color --filter-name MyFilter

Required Parameters

--filter-name

Name of the filter to be displayed.

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 store endpoint or store 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 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.

--endpoint

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

--feature

Name of the feature which contains the filter. If the feature flag key is different from the default key, provide the --key argument instead.

--index

Zero-based index of the filter to be displayed in case there are multiple instances with same filter name.

--key

Key of the feature flag. Key must start with the ".appconfig.featureflag/" prefix. Key cannot contain the "%" character. If both key and feature arguments are provided, only key will be used. Default key is the reserved prefix ".appconfig.featureflag/" + feature name.

--label

If no label specified, show 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>.

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 feature filter update

Update a filter in a feature flag.

az appconfig feature filter update --filter-name
                                   [--auth-mode {key, login}]
                                   [--connection-string]
                                   [--endpoint]
                                   [--feature]
                                   [--filter-parameters]
                                   [--index]
                                   [--key]
                                   [--label]
                                   [--name]
                                   [--yes]

Examples

Update the filter for feature 'color' with label MyLabel with name 'MyFilter' and 2 parameters.

az appconfig feature filter update -n MyAppConfiguration --feature color --label MyLabel --filter-name MyFilter --filter-parameters Name=\"Value\" Name2=\"Value2\"

Update the filter at index 2 (zero-based index) for feature 'color' with label MyLabel with name 'MyFilter' and 2 parameters.

az appconfig feature filter update -n MyAppConfiguration --feature color --label MyLabel --filter-name MyFilter --filter-parameters Name=\"Value\" Name2=\"Value2\" --index 2

Update a filter for feature 'color' with label MyLabel and filter name 'MyFilter' with no parameters

az appconfig feature filter update -n MyAppConfiguration --feature color --label MyLabel --filter-name MyFilter

Update the filter for feature 'color' with label MyLabel with name 'MyFilter' and array parameters.

az appconfig feature filter update -n MyAppConfiguration --feature color --label MyLabel --filter-name MyFilter --filter-parameters ArrayParam=[1,2,3]

Required Parameters

--filter-name

Name of the filter to be updated.

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 store endpoint or store 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

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

--endpoint

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

--feature

Name of the feature whose filter you want to update. If the feature flag key is different from the default key, provide the --key argument instead.

--filter-parameters

Space-separated filter parameters in 'name[=value]' format. The value must be an escaped JSON string.

--index

Zero-based index of the filter to be updated in case there are multiple instances with same filter name.

--key

Key of the feature flag. Key must start with the ".appconfig.featureflag/" prefix. Key cannot contain the "%" character. If both key and feature arguments are provided, only key will be used. Default key is the reserved prefix ".appconfig.featureflag/" + feature name.

--label

If no label specified, update 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>.

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