Поделиться через


Конфигурация Azure CLI

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

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

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

Настройка параметров с помощью az init

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

az init

Настройка параметров с помощью az config

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

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

Имя Описание
группа значений по умолчанию Группа ресурсов по умолчанию, используемая для всех команд.
значения_по_умолчанию.местоположение Расположение по умолчанию, используемое для всех команд.
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

Следующая команда отключает ссылки опроса при выполнении команд Azure CLI:

az config set core.survey_message=no

Файл конфигурации 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_ACCOUNTlocation задано в переменнойAZURE_DEFAULTS_LOCATION.

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

Секция Имя Тип Описание
ядро результат струна Формат выходных данных по умолчанию. Допустимые значения: json (по умолчанию), jsonc, yamlyamlc, table, tsv, none. Дополнительные сведения см. в статье Форматы выходных данных для команд Azure CLI.
отключить_запрос_подтверждения булевый Включите или отключите запросы на подтверждение.
отображаемый регион обнаружен булевый Клиенты Azure могут развертывать ресурсы во многих разных регионах. В некоторых случаях клиенты могут снизить затраты, выбрав близлежащие регионы, предлагающие те же услуги. Если определен ближайший регион, появится сообщение о том, что регион будет выбран для будущих развертываний. Этот параметр определяет, отображается ли сообщение.
сбор_телеметрии булевый Разрешить корпорации Майкрософт собирать анонимные данные об использовании интерфейса командной строки. Сведения о конфиденциальности см. в лицензии Azure CLI MIT.
только_показать_ошибки булевый Во время вызова команды отображаются только ошибки. Другими словами, только ошибки записываются в stderr. Он подавляет предупреждения из предварительной версии, устаревших и экспериментальных команд. Он также доступен для отдельных команд с параметром --only-show-errors .
включить брокера в Windows булевый Используйте диспетчер веб-учетных записей (WAM) для проверки подлинности в Azure с помощью az login команды.
login_experience_v2 булевый az login Включите или отключите селектор подписки.
без_цвета булевый Отключить цвет. Первоначально цветные сообщения имеют префиксы DEBUG, INFO, WARNING и ERROR. Этот логический параметр обходит проблему сторонней библиотеки, из-за которой цвет терминала не может вернуться после stdout перенаправления.
Клиенты Показать предупреждение о секретах булевый Включите или отключите предупреждение для выходных данных конфиденциальной информации.
логирование включить_логфайл булевый Включите или отключите ведение журнала.
папка_логов струна Каталог для записи журналов. По умолчанию это значение равно ${AZURE_CONFIG_DIR}/logs*.
По умолчанию группа струна Группа ресурсов по умолчанию, используемая для всех команд.
расположение струна Расположение по умолчанию, используемое для всех команд.
веб струна Имя приложения по умолчанию, используемое для az webapp команд.
виртуальная машина (VM) струна Имя виртуальной машины по умолчанию, используемое для az vm команд.
vmss струна Имя масштабируемого набора виртуальных машин по умолчанию (VMSS), используемое для az vmss команд.
acr струна Имя реестра контейнеров по умолчанию, используемое для az acr команд.
хранилище учетная запись струна Имя учетной записи хранения по умолчанию (например, mystorageaccount в https://mystorageaccount.blob.core.windows.net) для команд уровня данных (например, az storage).
ключ струна Ключ доступа по умолчанию, используемый для az storage команд плоскости данных.
sas_token струна Маркер SAS по умолчанию, используемый для az storage команд плоскости данных.
строка подключения струна Строка подключения по умолчанию, используемая для az storage команд плоскости данных.
batchai учетная запись хранилища струна Учетная запись хранения по умолчанию, используемая для az batchai команд.
ключ хранения струна Ключ хранилища по умолчанию, используемый для az batchai команд.
пакет учетная запись струна Имя учетной записи пакетной службы Azure по умолчанию, используемое для az batch команд.
ключ доступа струна Ключ доступа по умолчанию, используемый для az batch команд. Используется только с aad авторизацией.
конечная точка струна Конечная точка по умолчанию для подключения к az batch командам.
режим аутентификации струна Режим авторизации, используемый для az batch команд. Допустимые значения: shared_key, aad.
облако имя струна Облако по умолчанию для всех az команд. Допустимые значения: AzureCloud (по умолчанию), AzureChinaCloud. AzureUSGovernment Чтобы изменить облака, можно использовать az cloud set -–name команду. Пример см. в статье "Управление облаками" с помощью Azure CLI.
расширение используйте_динамическую_установку струна Установите расширение, если оно еще не добавлено, перед выполнением команды из него. Допустимые значения: no (по умолчанию), yes_prompt. yes_without_prompt
запуск_после_динамической_установки булевый Продолжайте выполнять команду при динамической установке расширения. По умолчанию — False.
index_url струна URL-адрес файла индекса частного расширения в соответствии с форматом index.json. После указания выполнение az extension add --name <extension-name> использует этот файл для поиска расширения, которое нужно добавить.

Замечание

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