AzurePowerShell@4 – tarefa Azure PowerShell v4
Use essa tarefa para executar um script do PowerShell em um ambiente do Azure. O contexto do Azure é autenticado com a conexão de serviço Resource Manager do Azure fornecida.
Syntax
# 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.
Entradas
azureSubscription
- Assinatura do Azure
Alias de entrada: ConnectedServiceNameARM
. string
. Obrigatórios.
O Azure Resource Manager assinatura a ser configurada antes de executar o PowerShell.
ScriptType
- Tipo de script
string
. Valores permitidos: FilePath
(Caminho do Arquivo de Script) InlineScript
(Script Embutido). Valor padrão: FilePath
.
O tipo do script: caminho do arquivo ou embutido.
ScriptPath
- Caminho do script
string
. Opcional. Use quando ScriptType = FilePath
.
O caminho do script. Esse deve ser um caminho totalmente qualificado ou um relativo ao diretório de trabalho padrão.
Inline
- Script embutido
string
. Opcional. Use quando ScriptType = InlineScript
. Valor padrão: # You can write your azure powershell scripts inline here. \n# You can also pass predefined and custom variables to this script using arguments
.
Especifica o script a ser executado. O comprimento máximo do script embutido com suporte é de 5.000 caracteres. Use um script de um arquivo se quiser usar um script mais longo.
ScriptArguments
- Argumentos de script
string
. Opcional. Use quando ScriptType = FilePath
.
Os parâmetros adicionais a serem passados para o PowerShell. Pode ser parâmetros ordinais ou nomeados.
errorActionPreference
- Erroractionpreference
string
. Valores permitidos: stop
, continue
, silentlyContinue
. Valor padrão: stop
.
Seleciona o valor da ErrorActionPreference
variável para executar o script.
FailOnStandardError
- Falha no Erro Padrão
boolean
. Valor padrão: false
.
Quando isso for verdadeiro, essa tarefa falhará se algum erro for gravado no pipeline de erro ou se algum dado for gravado no fluxo de erro padrão.
RestrictContextToCurrentTask
- Restringir o escopo do contexto à tarefa atual
boolean
. Valor padrão: false
.
Quando isso for verdadeiro, essa tarefa restringirá o escopo do contexto apenas à tarefa atual e o contexto não estará disponível para outras tarefas no pipeline ao usar um agente privado.
azurePowerShellVersion
- Versão do Azure PowerShell
Alias de entrada: TargetAzurePs
. string
. Valores permitidos: LatestVersion
(versão mais recente instalada) OtherVersion
(especifique outra versão). Valor padrão: OtherVersion
.
No caso de agentes hospedados, a versão de Azure PowerShell com suporte é: 1.0.0
(Fila VS2017 hospedada).
Para escolher a versão mais recente disponível no agente, selecione LatestVersion
(Versão mais recente instalada).
Para agentes privados, você pode especificar uma versão preferencial do Azure PowerShell usando OtherVersion
(especifique outra versão).
preferredAzurePowerShellVersion
- Versão de Azure PowerShell preferencial
Alias de entrada: CustomTargetAzurePs
. string
. Obrigatório quando TargetAzurePs = OtherVersion
.
A versão de Azure PowerShell preferencial precisa ser uma versão semântica adequada, por exemplo. 1.2.3.
Não há suporte para Regex como 2.\*,2.3.\*
. Atualmente, o pool do VS2017 hospedado dá suporte à versão do módulo Az 1.0.0.
pwsh
- Usar o PowerShell Core
boolean
. Valor padrão: false
.
Se isso for verdadeiro, no Windows, a tarefa usará pwsh.exe
do caminho em vez de powershell.exe
.
validateScriptSignature
- Validar assinatura de script
boolean
. Opcional. Use quando ScriptType = FilePath
. Valor padrão: false
.
Se isso for verdadeiro, a tarefa primeiro marcar para garantir que o script especificado seja assinado e válido antes de executá-lo.
workingDirectory
- Diretório de Trabalho
string
.
O diretório de trabalho em que o script é executado.
Opções de controle de tarefa
Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.
Variáveis de saída
Nenhum.
Comentários
Adicionado suporte para o Módulo Az e agentes de plataforma cruzada.
Requisitos
Requisito | Descrição |
---|---|
Tipos de pipeline | YAML, build clássico, versão clássica |
É executado em | Agent, DeploymentGroup |
Demandas | Nenhum |
Funcionalidades | Essa tarefa não atende a nenhuma demanda por tarefas subsequentes no trabalho. |
Restrições de comando | Qualquer |
Variáveis configuráveis | Qualquer |
Versão do agente | 2.115.0 ou superior |
Categoria da tarefa | Implantar |