AzurePowerShell@4 — задача Azure PowerShell версии 4
Используйте эту задачу для запуска скрипта PowerShell в среде Azure. Контекст Azure проходит проверку подлинности с помощью предоставленного подключения службы azure Resource Manager.
Синтаксис
# Azure PowerShell v4
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@4
inputs:
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. Azure Subscription.
#ScriptType: 'FilePath' # 'FilePath' | 'InlineScript'. Script Type. Default: FilePath.
#ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path.
#Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script.
#ScriptArguments: # string. Optional. Use when ScriptType = FilePath. Script Arguments.
#errorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. ErrorActionPreference. Default: stop.
#FailOnStandardError: false # boolean. Fail on Standard Error. Default: false.
#RestrictContextToCurrentTask: false # boolean. Restrict scope of context to current task. Default: false.
# Azure PowerShell version options
#azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version.
# Advanced
#pwsh: false # boolean. Use PowerShell Core. Default: false.
#validateScriptSignature: false # boolean. Optional. Use when ScriptType = FilePath. Validate script signature. Default: false.
#workingDirectory: # string. Working Directory.
# Azure PowerShell v4
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@4
inputs:
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. Azure Subscription.
#ScriptType: 'FilePath' # 'FilePath' | 'InlineScript'. Script Type. Default: FilePath.
#ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path.
#Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script.
#ScriptArguments: # string. Optional. Use when ScriptType = FilePath. Script Arguments.
#errorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. ErrorActionPreference. Default: stop.
#FailOnStandardError: false # boolean. Fail on Standard Error. Default: false.
#RestrictContextToCurrentTask: false # boolean. Restrict scope of context to current task. Default: false.
# Azure PowerShell version options
#azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version.
# Advanced
#pwsh: false # boolean. Use PowerShell Core. Default: false.
#workingDirectory: # string. Working Directory.
# Azure PowerShell v4
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@4
inputs:
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. Azure Subscription.
#ScriptType: 'FilePath' # 'FilePath' | 'InlineScript'. Script Type. Default: FilePath.
#ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path.
#Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script.
#ScriptArguments: # string. Optional. Use when ScriptType = FilePath. Script Arguments.
#errorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. ErrorActionPreference. Default: stop.
#FailOnStandardError: false # boolean. Fail on Standard Error. Default: false.
# Azure PowerShell version options
#azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version.
# Advanced
#pwsh: false # boolean. Use PowerShell Core. Default: false.
#workingDirectory: # string. Working Directory.
# Azure PowerShell v4
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@4
inputs:
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. Azure Subscription.
#ScriptType: 'FilePath' # 'FilePath' | 'InlineScript'. Script Type. Default: FilePath.
#ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path.
#Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script.
#ScriptArguments: # string. Optional. Use when ScriptType = FilePath. Script Arguments.
#errorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. ErrorActionPreference. Default: stop.
#FailOnStandardError: false # boolean. Fail on Standard Error. Default: false.
# Azure PowerShell version options
#azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version.
Входные данные
azureSubscription
-
Подписка Azure
Входной псевдоним: ConnectedServiceNameARM
.
string
. Обязательный.
Подписка azure Resource Manager для настройки перед запуском PowerShell.
ScriptType
-
Тип скрипта
string
. Допустимые значения: FilePath
(Путь к файлу скрипта), InlineScript
(встроенный скрипт). Значение по умолчанию: FilePath
.
Тип скрипта: путь к файлу или встроенный.
ScriptPath
-
Путь к скрипту
string
. Необязательный элемент. Используйте при ScriptType = FilePath
.
Путь к скрипту. Это должен быть полный путь или один относительно рабочего каталога по умолчанию.
Inline
-
Встроенный скрипт
string
. Необязательный элемент. Используйте при ScriptType = InlineScript
. Значение по умолчанию: # You can write your azure powershell scripts inline here. \n# You can also pass predefined and custom variables to this script using arguments
.
Указывает выполняемый скрипт. Максимальная поддерживаемая длина встроенного скрипта составляет 5000 символов. Используйте скрипт из файла, если вы хотите использовать более длинный скрипт.
ScriptArguments
-
Аргументы скрипта
string
. Необязательный элемент. Используйте при ScriptType = FilePath
.
Дополнительные параметры для передачи в PowerShell. Может быть порядковый или именованный параметр.
errorActionPreference
-
ErrorActionPreference
string
. Допустимые значения: stop
, continue
, silentlyContinue
. Значение по умолчанию: stop
.
Выбирает значение переменной ErrorActionPreference
для выполнения скрипта.
FailOnStandardError
-
Сбой при стандартной ошибке
boolean
. Значение по умолчанию: false
.
Если это верно, эта задача завершится сбоем, если в конвейер ошибок записываются какие-либо ошибки или если какие-либо данные записываются в стандартный поток ошибок.
RestrictContextToCurrentTask
-
Ограничение область контекста текущей задачей
boolean
. Значение по умолчанию: false
.
Если это так, эта задача ограничивает область контекста только текущей задачей, а контекст не будет доступен для других задач в конвейере при использовании частного агента.
azurePowerShellVersion
-
Версия Azure PowerShell
Входной псевдоним: TargetAzurePs
.
string
. Допустимые значения: LatestVersion
(последняя установленная версия), OtherVersion
(укажите другую версию). Значение по умолчанию: OtherVersion
.
Для размещенных агентов поддерживаемая версия Azure PowerShell: 1.0.0
(размещенная очередь VS2017).
Чтобы выбрать последнюю версию, доступную в агенте, выберите LatestVersion
(Последняя установленная версия).
Для частных агентов можно указать предпочтительную версию Azure PowerShell с помощью OtherVersion
(укажите другую версию).
preferredAzurePowerShellVersion
-
Предпочтительная версия Azure PowerShell
Входной псевдоним: CustomTargetAzurePs
.
string
. Требуется, если TargetAzurePs = OtherVersion
.
Предпочтительная версия Azure PowerShell должна быть правильной семантической версией, например.
1.2.3.
Регулярное выражение типа 2.\*,2.3.\*
не поддерживается. Размещенный пул VS2017 в настоящее время поддерживает версию модуля Az. 1.0.0.
pwsh
-
Использование PowerShell Core
boolean
. Значение по умолчанию: false
.
Если это так, то в Windows задача будет использовать pwsh.exe
из пути вместо powershell.exe
.
validateScriptSignature
-
Проверка подписи скрипта
boolean
. Необязательный элемент. Используйте при ScriptType = FilePath
. Значение по умолчанию: false
.
Если это так, задача сначала проверка, чтобы убедиться, что указанный скрипт подписан и действителен перед его выполнением.
workingDirectory
-
Рабочий каталог
string
.
Рабочий каталог, в котором выполняется скрипт.
Параметры управления задачами
Помимо входных данных, все задачи имеют параметры управления. Дополнительные сведения см. в разделе Параметры управления и общие свойства задачи.
Выходные переменные
Нет.
Remarks
Добавлена поддержка az module и кроссплатформенных агентов.
Требования
Требование | Описание |
---|---|
Типы конвейеров | YAML, классическая сборка, классический выпуск |
Выполняется в | Агент, DeploymentGroup |
Требования | Нет |
Capabilities | Эта задача не удовлетворяет требованиям для последующих задач в задании. |
Ограничения команд | Любой |
Устанавливаемые переменные | Любой |
Версия агента | 2.115.0 или более поздней версии |
Категория задач | Развертывание |