AzurePowerShell@3 - tarefa Azure PowerShell v3
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 v3
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@3
inputs:
#azureConnectionType: 'ConnectedServiceNameARM' # 'ConnectedServiceName' | 'ConnectedServiceNameARM'. Alias: ConnectedServiceNameSelector. Azure Connection Type. Default: ConnectedServiceNameARM.
#azureClassicSubscription: # string. Alias: ConnectedServiceName. Required when ConnectedServiceNameSelector = ConnectedServiceName. Azure Classic Subscription.
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM. 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
#validateScriptSignature: false # boolean. Optional. Use when ScriptType = FilePath. Validate script signature. Default: false.
# Azure PowerShell v3
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@3
inputs:
#azureConnectionType: 'ConnectedServiceNameARM' # 'ConnectedServiceName' | 'ConnectedServiceNameARM'. Alias: ConnectedServiceNameSelector. Azure Connection Type. Default: ConnectedServiceNameARM.
#azureClassicSubscription: # string. Alias: ConnectedServiceName. Required when ConnectedServiceNameSelector = ConnectedServiceName. Azure Classic Subscription.
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM. 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
azureConnectionType
- Tipo de conexão do Azure
Alias de entrada: ConnectedServiceNameSelector
. string
. Valores permitidos: ConnectedServiceName
(Azure Classic), ConnectedServiceNameARM
(Azure Resource Manager). Valor padrão: ConnectedServiceNameARM
.
azureClassicSubscription
- Assinatura Clássica do Azure
Alias de entrada: ConnectedServiceName
. string
. Obrigatório quando ConnectedServiceNameSelector = ConnectedServiceName
.
A assinatura clássica do Azure a ser configurada antes de executar o PowerShell.
azureSubscription
- Assinatura do Azure
Alias de entrada: ConnectedServiceNameARM
. string
. Obrigatório quando ConnectedServiceNameSelector = ConnectedServiceNameARM
.
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 de 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. Eles podem 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 erros padrão.
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, as versões de Azure PowerShell com suporte são 2.1.0
, 3.8.0
, 4.2.1
5.1.1
e 6.7.0
.
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
(Especificar 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, os agentes hospedados dão suporte às versões 2.1.0
do módulo do Azure , 3.8.0
, 4.2.1
5.1.1
e às versões 2.1.0
do módulo do AzureRM , 3.8.0
, 4.2.1
, , 5.1.1
, 6.7.0
.
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.
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 Falha no erro padrão e ErrorActionPreference.
Requisitos
Requisito | Descrição |
---|---|
Tipos de pipeline | YAML, build clássico, versão clássica |
Executa em | Agent, DeploymentGroup |
Demandas | Os agentes auto-hospedados devem ter recursos que correspondam às seguintes demandas para executar trabalhos que usam essa tarefa: azureps |
Funcionalidades | Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho. |
Restrições de comando | Qualquer |
Variáveis configuráveis | Qualquer |
Versão do agente | 2.0.0 ou superior |
Categoria da tarefa | Implantar |