LinuxCommandLibrary

az-appconfig

Manage Azure App Configuration resources

TLDR

Create an App Configuration

$ az appconfig create [[-n|--name]] [name] [[-g|--resource-group]] [group_name] [[-l|--location]] [location]
copy

Delete a specific App Configuration
$ az appconfig delete [[-g|--resource-group]] [rg_name] [[-n|--name]] [appconfig_name]
copy

List all App Configurations under the current subscription
$ az appconfig list
copy

List all App Configurations under a specific resource group
$ az appconfig list [[-g|--resource-group]] [rg_name]
copy

Show properties of an App Configuration
$ az appconfig show [[-n|--name]] [appconfig_name]
copy

Update a specific App Configuration
$ az appconfig update [[-g|--resource-group]] [rg_name] [[-n|--name]] [appconfig_name]
copy

SYNOPSIS


az appconfig command [parameters]

This command is a group of subcommands for managing Azure App Configuration. To see available subcommands, use az appconfig --help. To see parameters for a specific subcommand, use az appconfig command --help.

PARAMETERS

--name
    The name of the App Configuration store. Applicable to store-level commands like create, show, delete.

--resource-group
    Name of the resource group the App Configuration store belongs to.

--connection-string
    Connection string of the App Configuration store. Used for authentication when not relying on Azure Active Directory (AAD).

--key
    Key of the key-value pair. Used with `kv` subcommands for managing key-values.

--value
    Value of the key-value pair. Used with `kv` subcommands when setting or updating key-values.

--label
    Label of the key-value or feature flag. Used to create distinct versions of configurations (e.g., 'Dev', 'Prod').

--feature-name
    Name of the feature flag. Used with `feature` subcommands for managing feature flags.

--yes | -y
    Do not prompt for confirmation. Useful for scripting destructive operations.

--output | -o
    Output format (e.g., json, jsonc, table, tsv, yaml, yamlc, none). Specifies how the command's results are displayed.

--query
    JMESPath query string for filtering the output. Allows precise extraction of data from JSON output.

--debug
    Increase logging verbosity to show all debug logs, aiding in troubleshooting.

--verbose
    Increase logging verbosity to show more information during command execution.

--help | -h
    Show help message for the command or subcommand and exit.

DESCRIPTION

The `az appconfig` command group is an integral part of the Azure Command-Line Interface (Azure CLI), a powerful cross-platform toolset for managing Azure resources. Specifically, `az appconfig` provides comprehensive functionalities for interacting with and managing Azure App Configuration stores.

Azure App Configuration is a centralized service designed to store and manage application settings and feature flags. It enables developers to externalize configuration data from their code and manage it dynamically, supporting operations such as setting up and tearing down configuration stores, retrieving and updating key-value pairs, managing feature flags, and handling configurations with labels for different environments or versions.

This command group is essential for automating administrative tasks, integrating configuration management into CI/CD pipelines, and providing a programmatic interface for managing application settings, making it suitable for modern cloud-native applications as well as traditional applications migrating to the cloud.

CAVEATS


1. This command is part of the Azure CLI, not a standard Linux utility. It requires the Azure CLI to be installed and configured on your system.
2. An active Azure subscription and an authenticated Azure account are necessary to interact with Azure App Configuration resources.
3. Specific parameters and their usage can vary significantly depending on the subcommand used (e.g., `kv`, `feature`, `replica`). Always refer to the `--help` output for the specific subcommand you are using for the most accurate and complete list of options.
4. Network connectivity to Azure services is required for its operation.

KEY CONCEPTS


Azure App Configuration manages two primary types of data: key-value pairs (for general application settings) and feature flags (for dynamically enabling/disabling features). The `az appconfig kv` and `az appconfig feature` subcommands are specifically designed for managing these respective data types.

INTEGRATION WITH APPLICATIONS


While `az appconfig` is used for administrative tasks, applications typically consume settings from Azure App Configuration using dedicated client SDKs available for various programming languages (e.g., .NET, Java, Python, JavaScript). These SDKs handle caching, refresh, and connection details, abstracting the underlying configuration store.

HISTORY

Azure App Configuration was introduced as a public preview service in 2019, providing a modern, centralized service for managing application settings and feature flags. The `az appconfig` command group was developed as part of the Azure CLI's continuous evolution to support new Azure services and features. Its inclusion allowed developers and operations teams to automate the management of their configuration stores directly from the command line or scripts, aligning with the broader Azure CLI philosophy of providing a consistent and intuitive command-line experience across all Azure services.

SEE ALSO

az account (Azure CLI command for managing Azure subscriptions), az group (Azure CLI command for managing Azure resource groups), az login (Azure CLI command for authenticating to Azure)

Copied to clipboard