Partilhar via


AzurePowerShell@3 - tarefa Azure PowerShell v3

Utilize esta tarefa para executar um script do PowerShell num ambiente do Azure. O contexto do Azure é autenticado com a ligação de serviço do Azure Resource Manager 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 Ligação do Azure
Alias de entrada: ConnectedServiceNameSelector. string. Valores permitidos: ConnectedServiceName (Azure Classic), ConnectedServiceNameARM (Azure Resource Manager). Valor predefinido: ConnectedServiceNameARM.


azureClassicSubscription - Subscrição Clássica do Azure
Alias de entrada: ConnectedServiceName. string. Necessário quando ConnectedServiceNameSelector = ConnectedServiceName.

A subscrição clássica do Azure para configurar antes de executar o PowerShell.


azureSubscription - Subscrição do Azure
Alias de entrada: ConnectedServiceNameARM. string. Necessário quando ConnectedServiceNameSelector = ConnectedServiceNameARM.

A subscrição do Azure Resource Manager para configurar antes de executar o PowerShell.


ScriptType - Tipo de Script
string. Valores permitidos: FilePath (Caminho do Ficheiro de Script), InlineScript (Script Inline). Valor predefinido: FilePath.

O tipo do script: caminho do ficheiro ou inline.


ScriptPath - Caminho do Script
string. Opcional. Utilize quando ScriptType = FilePath.

O caminho do script. Este deve ser um caminho completamente qualificado ou um relativo ao diretório de trabalho predefinido.


Inline - Inline Script
string. Opcional. Utilize quando ScriptType = InlineScript. Valor predefinido: # 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 executar. O comprimento máximo do script inline suportado é de 5000 carateres. Utilize um script de um ficheiro se quiser utilizar um script mais longo.


ScriptArguments - Argumentos de Script
string. Opcional. Utilize quando ScriptType = FilePath.

Os parâmetros adicionais a transmitir para o PowerShell. Estes podem ser parâmetros ordinais ou nomeados.


errorActionPreference - ErrorActionPreference
string. Valores permitidos: stop, , continuesilentlyContinue. Valor predefinido: stop.

Seleciona o valor da ErrorActionPreference variável para executar o script.


FailOnStandardError - Falha no Erro Padrão
boolean. Valor predefinido: false.

Quando for verdade, esta tarefa falhará se forem escritos erros no pipeline de erros ou se forem escritos dados no fluxo de erros padrão.


azurePowerShellVersion - Versão do Azure PowerShell
Alias de entrada: TargetAzurePs. string. Valores permitidos: LatestVersion (Versão instalada mais recente), OtherVersion (Especifique outra versão). Valor predefinido: OtherVersion.

No caso dos agentes alojados, as Versões de Azure PowerShell suportadas são 2.1.0, 3.8.0, 4.2.15.1.1 e 6.7.0. Para escolher a versão mais recente disponível no agente, selecione LatestVersion (Versão instalada mais recente).

Para agentes privados, pode especificar uma versão preferencial do Azure PowerShell com OtherVersion (Especificar outra versão).


preferredAzurePowerShellVersion - Versão de Azure PowerShell Preferencial
Alias de entrada: CustomTargetAzurePs. string. Necessário quando TargetAzurePs = OtherVersion.

A Versão de Azure PowerShell preferencial tem de ser uma versão semântica adequada, por exemplo. 1.2.3.. Regex like 2.\*,2.3.\* não é suportado. Atualmente, os agentes alojados suportam versões 2.1.0do módulo do Azure , 3.8.0, 5.1.14.2.1e versões 2.1.0do módulo do AzureRM , , 3.8.0, 4.2.1, 5.1.1, 6.7.0.


validateScriptSignature - Validar assinatura de script
boolean. Opcional. Utilize quando ScriptType = FilePath. Valor predefinido: false.

Se for verdade, a tarefa irá primeiro verificar se o script especificado está assinado e válido antes de executá-lo.


Opções de controlo de tarefas

Todas as tarefas têm opções de controlo para além das entradas de tarefas. Para obter mais informações, veja Opções de controlo e propriedades de tarefas comuns.

Variáveis de saída

Nenhum.

Observações

Foi adicionado suporte para Falha no erro padrão e ErrorActionPreference.

Requisitos

Requisito Description
Tipos de pipeline YAML, Compilação clássica, Versão clássica
É executado em Agente, DeploymentGroup
Exigências Os agentes autoalojados têm de ter capacidades que correspondam às seguintes exigências para executar tarefas que utilizam esta tarefa: azureps
Capacidades Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa.
Restrições de comandos Qualquer
Variáveis de tabelas definidas Qualquer
Versão do agente 2.0.0 ou superior
Categoria da tarefa Implementação