AzureCLI@1 — задача Azure CLI версии 1

Статья
07/02/2024

Выполнение команд Azure CLI в подписке Azure в скрипте оболочки при запуске в агенте Linux или пакетном скрипте при запуске в агенте Windows.

Выполнение скрипта оболочки или пакетной службы с помощью команд Azure CLI для подписки Azure.

Синтаксис

# Azure CLI v1
# Run Azure CLI commands against an Azure subscription in a Shell script when running on Linux agent or Batch script when running on Windows agent.
- task: AzureCLI@1
  inputs:
    azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure subscription. 
    scriptLocation: 'scriptPath' # 'inlineScript' | 'scriptPath'. Required. Script Location. Default: scriptPath.
    scriptPath: # string. Required when scriptLocation = scriptPath. Script Path. 
    #inlineScript: # string. Required when scriptLocation = inlineScript. Inline Script. 
    #arguments: # string. Alias: args. Arguments. 
  # Advanced
    #addSpnToEnvironment: false # boolean. Access service principal details in script. Default: false.
    #useGlobalConfig: false # boolean. Use global Azure CLI configuration. Default: false.
    #workingDirectory: # string. Alias: cwd. Working Directory. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

# Azure CLI v1
# Run a Shell or Batch script with Azure CLI commands against an azure subscription.
- task: AzureCLI@1
  inputs:
    azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure subscription. 
    scriptLocation: 'scriptPath' # 'inlineScript' | 'scriptPath'. Required. Script Location. Default: scriptPath.
    scriptPath: # string. Required when scriptLocation = scriptPath. Script Path. 
    #inlineScript: # string. Required when scriptLocation = inlineScript. Inline Script. 
    #arguments: # string. Alias: args. Arguments. 
  # Advanced
    #workingDirectory: # string. Alias: cwd. Working Directory. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

Входные данные

azureSubscription - Подписка Azure
Входной псевдоним: connectedServiceNameARM. string. Обязательный.

Выбирает подписку azure Resource Manager для развертывания.

scriptLocation - Расположение скрипта
string. Обязательный. Допустимые значения: inlineScript (встроенный скрипт), scriptPath (путь к скрипту). Значение по умолчанию: scriptPath.

Выбирает расположение скрипта.

scriptPath - Путь к скрипту
string. Требуется, если scriptLocation = scriptPath.

Полный путь к скрипту или путь относительно рабочего каталога по умолчанию.

inlineScript - Встроенный скрипт
string. Требуется, если scriptLocation = inlineScript.

Скрипты можно написать здесь. При использовании агента Windows используйте пакетные скрипты. Использование скриптов оболочки при использовании агентов на основе Linux. Для пакетных файлов используйте префикс call перед каждой командой Azure. Вы также можете передать предопределенные и пользовательские переменные в этот скрипт с помощью аргументов.

См. следующие примеры. Первый является примером оболочки, а второй — пакетным примером:

azure --version || azure account show

call  azure --version || call azure account show

arguments - Аргументы
Входной псевдоним: args. string.

Аргументы, передаваемые в скрипт.

addSpnToEnvironment - Доступ к сведениям о субъекте-службе в скрипте
boolean. Значение по умолчанию: false.

Добавляет идентификатор субъекта-службы и ключ выбранной конечной точки Azure в среду выполнения скрипта. В скрипте $servicePrincipalId можно использовать переменные и $servicePrincipalKey .

Они учитываются, только если конечная точка Azure имеет схему проверки подлинности субъекта-службы.

useGlobalConfig - Использование глобальной конфигурации Azure CLI
boolean. Значение по умолчанию: false.

Если задано значение false, эта задача будет использовать собственный отдельный каталог конфигурации Azure CLI. Его можно использовать для запуска задач Azure CLI в параллельных выпусках.

workingDirectory - Рабочий каталог
Входной псевдоним: cwd. string.

Текущий рабочий каталог, в котором выполняется скрипт. Если оставить это поле пустым, эти входные данные являются корнем репозитория (сборка) или артефактами (выпуск), то есть $(System.DefaultWorkingDirectory).

failOnStandardError - Сбой при стандартной ошибке
boolean. Значение по умолчанию: false.

Если эти входные данные имеют значение true, эта задача завершится сбоем при записи ошибок в поток StandardError. Снимите флажок, чтобы игнорировать стандартные ошибки и использовать коды выхода для определения состояния.

Параметры управления задачами

Помимо входных данных, все задачи имеют параметры управления. Дополнительные сведения см. в разделе Параметры управления и общие свойства задачи.

Выходные переменные

Нет.

Remarks

Новые возможности версии 1.0:

Поддерживает новую версию Azure CLI 2.0 на основе Python.
Работает с кроссплатформенными агентами (Linux, macOS или Windows)
Для работы с Azure CLI 1.0 (на основе node.js) переключитесь на задачу версии 0.0.
Ограничения: — не поддерживает классические подписки Azure. Azure CLI 2.0 поддерживает только подписки Azure Resource Manager (ARM).

Требования

Требование	Описание
Типы конвейеров	YAML, классическая сборка, классический выпуск
Выполняется в	Агент, DeploymentGroup
Требования	None
Capabilities	Эта задача не удовлетворяет требованиям для последующих задач в задании.
Ограничения команд	Любой
Устанавливаемые переменные	Любой
Версия агента	2.0.0 или более поздней версии
Категория задач	Развертывание

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