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.
Входные данные
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.
regex, например 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
.
Рабочий каталог, в котором выполняется скрипт.
Параметры управления задачами
Помимо входных данных, все задачи имеют параметры управления. Дополнительные сведения см. в разделе Параметры управления и общие свойства задач.
Выходные переменные
Нет.
Замечания
Добавлена поддержка Az Module и кроссплатформенных агентов.
Требования
Требование | Описание |
---|---|
Типы конвейеров | YAML, классическая сборка, классический выпуск |
Выполняется в | Агент, DeploymentGroup |
требования | Нет |
возможностей | Эта задача не удовлетворяет требованиям к последующим задачам в задании. |
ограничения команд | Любое |
переменные settable | Любое |
Версия агента | 2.115.0 или более поздней версии |
Категория задач | Внедрять |