Compartilhar via

tarefa AzureCLI@1 - CLI do Azure v1

  • Artigo

Execute comandos da CLI do Azure em uma assinatura do Azure em um script de shell ao executar no agente do Linux ou no script em lote ao ser executado no agente do Windows.

Execute um shell ou script em lote com comandos da CLI do Azure em uma assinatura do Azure.

Syntax

# Azure CLI v1
# Run Azure CLI commands against an Azure subscription in a Shell script when running on Linux agent or Batch script when running on Windows agent.
- task: AzureCLI@1
  inputs:
    azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure subscription. 
    scriptLocation: 'scriptPath' # 'inlineScript' | 'scriptPath'. Required. Script Location. Default: scriptPath.
    scriptPath: # string. Required when scriptLocation = scriptPath. Script Path. 
    #inlineScript: # string. Required when scriptLocation = inlineScript. Inline Script. 
    #arguments: # string. Alias: args. Arguments. 
  # Advanced
    #addSpnToEnvironment: false # boolean. Access service principal details in script. Default: false.
    #useGlobalConfig: false # boolean. Use global Azure CLI configuration. Default: false.
    #workingDirectory: # string. Alias: cwd. Working Directory. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

# Azure CLI v1
# Run a Shell or Batch script with Azure CLI commands against an azure subscription.
- task: AzureCLI@1
  inputs:
    azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure subscription. 
    scriptLocation: 'scriptPath' # 'inlineScript' | 'scriptPath'. Required. Script Location. Default: scriptPath.
    scriptPath: # string. Required when scriptLocation = scriptPath. Script Path. 
    #inlineScript: # string. Required when scriptLocation = inlineScript. Inline Script. 
    #arguments: # string. Alias: args. Arguments. 
  # Advanced
    #workingDirectory: # string. Alias: cwd. Working Directory. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

Entradas

azureSubscription - Assinatura do Azure
Alias de entrada: connectedServiceNameARM. string. Obrigatórios.

Seleciona uma assinatura do Azure Resource Manager para a implantação.


scriptLocation - Local do script
string. Obrigatórios. Valores permitidos: inlineScript (script embutido) scriptPath (Caminho do script). Valor padrão: scriptPath.

Seleciona o local do script.


scriptPath - Caminho do script
string. Obrigatório quando scriptLocation = scriptPath.

Caminho totalmente qualificado do script ou um caminho relativo ao diretório de trabalho padrão.


inlineScript - Script embutido
string. Obrigatório quando scriptLocation = inlineScript.

Você pode escrever seus scripts embutidos aqui. Ao usar o agente do Windows, use scripts em lote. Use scripts de shell ao usar agentes baseados em Linux. Para arquivos em lote, use o prefixo call antes de cada comando do Azure. Você também pode passar variáveis predefinidas e personalizadas para esse script usando argumentos

Consulte os exemplos a seguir. O primeiro é um exemplo de shell e o segundo é um exemplo em lote:

azure --version || azure account show 

call  azure --version || call azure account show

arguments - Argumentos
Alias de entrada: args. string.

Argumentos passados para o script.


addSpnToEnvironment - Acessar detalhes da entidade de serviço no script
boolean. Valor padrão: false.

Adiciona a ID da entidade de serviço e a chave do ponto de extremidade do Azure que você escolheu para o ambiente de execução do script. Você pode usar as $servicePrincipalId variáveis e $servicePrincipalKey em seu script.

Isso é atendido somente quando o ponto de extremidade do Azure tem o esquema de autenticação da Entidade de Serviço.


useGlobalConfig - Usar a configuração global da CLI do Azure
boolean. Valor padrão: false.

Se isso for falso, essa tarefa usará seu próprio diretório de configuração separado da CLI do Azure. Isso pode ser usado para executar tarefas da CLI do Azure em versões paralelas .


workingDirectory - Diretório de Trabalho
Alias de entrada: cwd. string.

Diretório de trabalho atual em que o script é executado. Se deixado em branco, essa entrada será a raiz do repositório (build) ou artefatos (versão), que é $(System.DefaultWorkingDirectory).


failOnStandardError - Falha no Erro Padrão
boolean. Valor padrão: false.

Se essa entrada for verdadeira, essa tarefa falhará quando quaisquer erros forem gravados no fluxo StandardError. Desmarque a caixa de seleção para ignorar erros padrão e, em vez disso, conte com códigos de saída para determinar o status.


Opções de controle da 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

Novidades na versão 1.0:

  • Dá suporte à nova CLI do Azure 2.0, que é baseada em Python
  • Funciona com agentes multiplataforma (Linux, macOS ou Windows)
  • Para trabalhar com a CLI do Azure 1.0 (baseada em node.js), alterne para a versão da tarefa 0.0
  • Limitações: – Sem suporte para assinaturas clássicas do Azure. A CLI do Azure 2.0 dá suporte apenas a assinaturas do ARM (Azure Resource Manager).

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.0.0 ou superior
Categoria da tarefa Implantar