Azure CLI configuration

The Azure CLI allows for user configuration for settings such as logging, data collection, and default argument values. The CLI offers a convenience command for managing some defaults, az config, and an interactive option through az init. Other values can be set in a configuration file or with environment variables. This article provides further information on these user configuration settings and how to configure the Azure CLI.

Configuration values used by the CLI are evaluated in the following precedence, with items higher on the list taking priority.

1. Параметры командной строки
2. Переменные среды
3. Values in the configuration file set with az config or az init

Configure settings using az init

The easiest way to set Azure CLI configurations is to use the interactive az init command. Choose a common configuration like "interaction" or "automation," or opt to walk through individual configurations. What is especially helpful with this approach is az init provides reasons why you might want to choose one configuration option over another.

az init

Configure settings using az config

You can set defaults for the CLI with the az config set command. This command takes a space-separated list of key=value pairs as an argument. The provided values are used by the Azure CLI in place of required arguments.

The following table contains a list of available configuration keys.

As an example, here's how you would set the default resource group and location for all commands.

az config set defaults.location=westus2 defaults.group=MyResourceGroup

The following command turns off the survey links while executing the Azure CLI commands:

az config set output.show_survey_link=no

CLI configuration file

The CLI configuration file contains other settings that are used for managing CLI behavior. Файл конфигурации расположен здесь: $AZURE_CONFIG_DIR/config. По умолчанию для AZURE_CONFIG_DIR устанавливается значение $HOME/.azure в Linux и macOS и %USERPROFILE%\.azure в Windows.

Configuration files are written in the INI file format. Section headers define the file format, followed by a list of key-value entries.

• Section headers are written as [section-name]. Section names are case-sensitive.
• Entries are written as key=value. Key names aren't case-sensitive.
• Comments are any line that begins with a # or ;. Inline comments aren't allowed.

Booleans are case-insensitive. The following values represent booleans:

• True: 1, yes, true, on
• False: 0, no, false, off

Here's an example of a CLI configuration file that disables any confirmation prompts and sets up logging to the /var/log/azure directory.

[core]
disable_confirm_prompt=Yes

[logging]
enable_log_file=yes
log_dir=/var/log/azure

See the next section for details on all of the available configuration values and what they mean. For the full details on the INI file format, see the Python documentation on INI.

CLI configuration values and environment variables

The following table contains all of the sections and option names that can be placed in a configuration file. Their corresponding environment variables are set as AZURE_{section}_{name}, in all caps. For example, output default for core is set in the AZURE_CORE_OUTPUT variable, the storage_account default for batchai is set in the AZURE_BATCHAI_STORAGE_ACCOUNT variable, and the default location is set in the AZURE_DEFAULTS_LOCATION variable.

When you provide a default value, that argument is no longer required by any command. Instead, the default value is used.