Настройка Azure CLI
С помощью Azure CLI пользователи могут настраивать различные параметры, например для ведения журналов и сбора данных, а также значения аргументов по умолчанию. Интерфейс командной строки предлагает удобную команду для управления некоторыми значениями по умолчанию (az config) и интерактивный вариант через az init. Другие значения можно указать в файле конфигурации или с помощью переменных среды. Эта статья содержит дополнительные сведения об этих пользовательских параметрах конфигурации и том, как настроить Azure CLI.
Значения конфигурации, используемые CLI, вычисляются в указанном ниже порядке. Элементы, расположенные выше в списке, имеют больший приоритет.
- Параметры командной строки
- Переменные среды
- Значения, содержащиеся в файле конфигурации, заданные с помощью команды
az configилиaz init.
Настройка параметров с помощью az init
Самый простой способ настроить конфигурации Azure CLI — использовать интерактивную команду az init. Выберите общую конфигурацию, например "взаимодействие" или "автоматизацию", или выберите отдельные конфигурации. Этот подход особенно полезен, потому что az init указывает причины, по которым одна конфигурация предпочтительнее другой.
az init
Настройка параметров с помощью az config
Задать значения по умолчанию для CLI можно с помощью команды az config set.
Эта команда принимает разделенный пробелами список пар key=value в качестве аргумента. Предоставленные значения используются в Azure 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
Следующая команда отключает ссылки на опросы при выполнении команд Azure CLI:
az config set output.show_survey_link=no
Файл конфигурации 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.
Если указать значение по умолчанию, любая команда больше не будет требовать этот аргумент. Вместо этого используется значение по умолчанию.
| Раздел | Имя. | Тип | Описание |
|---|---|---|---|
| core | output | строка | Формат вывода по умолчанию. Допустимые значения: json (по умолчанию), jsonc, yamlyamlc, table, tsv, none. Дополнительные сведения см. в статье Форматы выходных данных для команд Azure CLI. |
| disable_confirm_prompt | boolean | Включает и отключает запросы на подтверждение. | |
| display_region_identified | boolean | Клиенты Azure могут развертывать ресурсы во многих разных регионах. В некоторых случаях клиенты могут снизить затраты, выбрав близлежащие регионы, предлагающие те же услуги. Если определен ближайший регион, появится сообщение о том, что регион будет выбран для будущих развертываний. Этот параметр определяет, отображается ли сообщение. | |
| collect_telemetry | boolean | Разрешает корпорации Майкрософт собирать анонимные данные об использовании CLI. Сведения о конфиденциальности см. в лицензии MIT для Azure CLI. | |
| only_show_errors | boolean | Показывает ошибки только при вызове команды. Другими словами, только ошибки записываются stderrв . При этом подавляются предупреждения от команд предварительной версии, а также нерекомендуемых и экспериментальных команд. Он также доступен для отдельных команд с параметром --only-show-errors . |
|
| no_color | boolean | Отключает цвет. Первоначально цветные сообщения префиксируются с DEBUG, INFOWARNING и ERROR. Этот логический обход проходит проблему сторонней библиотеки, где цвет терминала не может отменить изменения обратно после stdout перенаправления. |
|
| Клиентов | show_secrets_warning | boolean | Включите или отключите предупреждение для выходных данных конфиденциальной информации. |
| logging | enable_log_file | boolean | Включение и отключение ведения журнала. |
| log_dir | строка | Каталог для записи журналов. По умолчанию это значение равно ${AZURE_CONFIG_DIR}/logs*. |
|
| defaults | group | строка | Группа ресурсов по умолчанию для всех команд. |
| Расположение | строка | Расположение по умолчанию для всех команд. | |
| web | строка | Имя приложения по умолчанию для команд az webapp. |
|
| VM | строка | Имя виртуальной машины по умолчанию для команд az vm. |
|
| vmss | строка | Имя масштабируемого набора виртуальных машин (VMSS) по умолчанию, используемое в командах az vmss. |
|
| acr | строка | Имя реестра контейнеров по умолчанию для az acr команд. |
|
| storage | организация | строка | Имя учетной записи хранения по умолчанию (например, mystorageaccount in 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 | организация | строка | Учетная запись пакетной службы по умолчанию для команд az batch. |
| access_key | строка | Ключ доступа по умолчанию для команд az batch. Используется только с авторизацией aad. |
|
| конечная точка | строка | Конечная точка по умолчанию для подключения для команд az batch. |
|
| auth_mode | строка | Режим авторизации для команд az batch. Допустимые значения: shared_key, aad. |
|
| cloud | name | строка | Облако по умолчанию для всех команд az. Допустимые значения: AzureCloud (по умолчанию), AzureChinaCloud. AzureUSGovernment Чтобы изменить облака, можно использовать команду az cloud set –name. Пример см. в статье Выбор облаков с помощью Azure CLI. |
| extension | use_dynamic_install | строка | Установите расширение, если оно не было добавлено при выполнении команды. Допустимые значения: no (по умолчанию), yes_prompt. yes_without_prompt |
| run_after_dynamic_install | boolean | Продолжайте выполнять команду при динамической установке расширения. По умолчанию — False. |
|
| index_url | строка | URL-адрес файла индекса частного расширения, который следует формату в index.json. После указания выполнение az extension add --name <extension-name> этого файла использует этот файл для поиска расширения для добавления. |
Примечание.
В файле конфигурации могут быть и другие значения, но управление ими осуществляется непосредственно с помощью команд CLI, включая az config. Те, которые перечислены в таблице ранее, являются единственными значениями, которые следует изменить самостоятельно.