Настройка Azure CLI

С помощью Azure CLI пользователи могут настраивать различные параметры, например для ведения журналов и сбора данных, а также значения аргументов по умолчанию. Интерфейс командной строки содержит удобную команду для управления некоторыми значениями по умолчанию — az config. Другие значения можно указать в файле конфигурации или с помощью переменных среды. Эта статья содержит дополнительные сведения об этих пользовательских параметрах конфигурации и том, как настроить Azure CLI.

Значения конфигурации, используемые CLI, вычисляются в указанном ниже порядке. Элементы, расположенные выше в списке, имеют больший приоритет.

  1. Параметры командной строки
  2. Хранимые значения параметра установлены с помощью команды az config param-persist
  3. Переменные среды
  4. Значения в файле конфигурации, заданные с помощью команды az config

Настройка CLI с использованием команды az config

Задать значения по умолчанию для CLI можно с помощью команды az config set. Эта команда принимает разделенный пробелами список пар key=value в качестве аргумента. Предоставленные значения используются в CLI вместо обязательных аргументов.

Следующая таблица содержит список доступных ключей конфигурации.

Имя Описание
defaults.group Группа ресурсов по умолчанию для всех команд.
defaults.location Расположение по умолчанию для всех команд.
defaults.web Имя приложения по умолчанию для команд az webapp.
defaults.vm Имя виртуальной машины по умолчанию для команд az vm.
defaults.vmss Имя масштабируемого набора виртуальных машин (VMSS) по умолчанию, используемое в командах az vmss.
defaults.acr Имя реестра контейнеров по умолчанию для az acr команд.

Вот пример того, как можно задать группу ресурсов и расположение по умолчанию для всех команд:

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

Файл конфигурации CLI

Файл конфигурации CLI содержит другие параметры, которые используются для управления поведением CLI. Файл конфигурации расположен здесь: $AZURE_CONFIG_DIR/config. По умолчанию для AZURE_CONFIG_DIR устанавливается значение $HOME/.azure в Linux и macOS и %USERPROFILE%\.azure в Windows.

Файлы конфигурации записываются в формате INI. Формат файла определяется заголовками разделов, за которыми следует список пар "ключ-значение".

  • Заголовки разделов указываются следующим образом: [section-name]. В именах разделов учитывается регистр.
  • Параметры записываются следующим образом: key=value. В именах ключей регистр не учитывается.
  • Комментарии — это любая строка, начинающаяся с # или ;. Встроенные комментарии не допускаются.

Логические операторы не зависят от регистра и представлены следующими значениями:

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

Ниже приведен пример файла конфигурации CLI, который отключает все запросы на подтверждение и настраивает для ведения журнала папку /var/log/azure.

[core]
disable_confirm_prompt=Yes

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

Сведения обо всех доступных значениях параметров конфигурации и их описание см. в следующем разделе. Дополнительные сведения о формате INI см. в документации Python по файлам INI.

Переменные среды и значения конфигурации CLI

Следующая таблица содержит все разделы и имена параметров, которые могут быть включены в файл конфигурации. Соответствующие переменные среды имеют формат AZURE_{section}_{name} и записываются прописными. Например, значение по умолчанию output для core задается в переменной AZURE_CORE_OUTPUT, значение по умолчанию storage_account для batchai — в переменной AZURE_BATCHAI_STORAGE_ACCOUNT, а значение по умолчанию location — в переменной AZURE_DEFAULTS_LOCATION.

Если указать значение по умолчанию, любая команда больше не будет требовать этот аргумент. Вместо этого используется значение по умолчанию.

Section Имя Тип Описание
core output строка Формат вывода по умолчанию. Может иметь значение json, jsonc, tsv или table.
disable_confirm_prompt Логическое Включает и отключает запросы на подтверждение.
collect_telemetry Логическое Разрешает корпорации Майкрософт собирать анонимные данные об использовании CLI. Сведения о конфиденциальности см. в лицензии MIT для Azure CLI.
only_show_errors Логическое Показывает ошибки только при вызове команды. Иными словами, в stderrбудут записываться только ошибки. При этом подавляются предупреждения от команд предварительной версии, а также нерекомендуемых и экспериментальных команд. Также предоставляется для отдельных команд с параметром --only-show-errors.
no_color Логическое Отключает цвет. Сообщения, выделенные цветом, будут иметь префикс DEBUG, INFO, WARNING и ERROR. Так устраняется проблема со сторонней библиотекой, при использовании которой цвет терминала нельзя отменить изменения после перенаправления stdout.
logging enable_log_file Логическое Включение и отключение ведения журнала.
log_dir строка Каталог для записи журналов. По умолчанию это значение равно ${AZURE_CONFIG_DIR}/logs*.
defaults group строка Группа ресурсов по умолчанию для всех команд.
location строка Расположение по умолчанию для всех команд.
web строка Имя приложения по умолчанию для команд az webapp.
vm строка Имя виртуальной машины по умолчанию для команд az vm.
vmss строка Имя масштабируемого набора виртуальных машин (VMSS) по умолчанию, используемое в командах az vmss.
acr строка Имя реестра контейнеров по умолчанию для az acr команд.
storage account строка Имя учетной записи хранения по умолчанию (например, mystorageaccount в https://mystorageaccount.blob.core.windows.net) для использования с командами плоскости данных az storage (например, az storage container list ).
ключ строка Ключ доступа по умолчанию для использования с командами плоскости данных az storage.
sas_token строка Маркер SAS по умолчанию для использования с командами плоскости данных az storage.
connection_string строка Строка подключения по умолчанию для использования с командами плоскости данных az storage.
batchai storage_account строка Учетная запись хранения по умолчанию для команд az batchai.
storage_key строка Ключ к хранилищу данных по умолчанию для команд az batchai.
batch account строка Учетная запись пакетной службы по умолчанию для команд az batch.
access_key строка Ключ доступа по умолчанию для команд az batch. Используется только с авторизацией aad.
endpoint строка Конечная точка по умолчанию для подключения для команд az batch.
auth_mode строка Режим авторизации для команд az batch. Может иметь значение shared_key или aad.
cloud name строка Облако по умолчанию для всех команд az. Допустимые значения — AzureCloud (по умолчанию), AzureChinaCloud, AzureUSGovernment и AzureGermanCloud. Чтобы изменить облака, можно использовать команду az cloud set –name. Пример см. в статье Выбор облаков с помощью Azure CLI.
extension use_dynamic_install строка Установите расширение, если оно не было добавлено при выполнении команды. Допустимые значения — no (по умолчанию), yes_prompt, yes_without_prompt.
run_after_dynamic_install Логическое Продолжайте выполнять команду при динамической установке расширения. Значение по умолчанию — False.

Примечание

В файле конфигурации могут быть и другие значения, но управление ими осуществляется непосредственно с помощью команд CLI, включая az config. Самостоятельно изменить можно только значения, перечисленные в таблице выше.

См. также раздел