Partilhar via


AzureCLI@1 - Tarefa Azure CLI v1

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

Sintaxe

# 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.

Insumos

azureSubscription - de assinatura do Azure
Alias de entrada: connectedServiceNameARM. string. Obrigatório.

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


scriptLocation - Localização do script
string. Obrigatório. Valores permitidos: inlineScript (script embutido), scriptPath (caminho do script). Valor padrão: scriptPath.

Seleciona o local do script.


scriptPath - caminho do script
string. Necessário quando scriptLocation = scriptPath.

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


inlineScript - Script Inline
string. Necessário quando scriptLocation = inlineScript.

Você pode escrever seus scripts em linha aqui. Ao usar o agente do Windows, use scripts em lote. Use shell scripting 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

Veja os exemplos a seguir. O primeiro é um exemplo de shell e o segundo é um exemplo de 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 - Detalhes da entidade de serviço do Access 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 ao ambiente de execução do script. Você pode usar as variáveis $servicePrincipalId e $servicePrincipalKey em seu script.

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


useGlobalConfig - Usar de 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 CLI do Azure. Isso pode ser usado para executar tarefas da CLI do Azure em versões de paralelas.


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

Diretório de trabalho atual onde o script é executado. Se deixada em branco, essa entrada é a raiz do repositório (build) ou artefatos (release), 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, confie nos códigos de saída para determinar o status.


Opções de controlo de tarefas

Todas as tarefas têm opções de controle, além de suas entradas de tarefas. Para obter mais informações, consulte Opções de controle de e propriedades de tarefas comuns.

Variáveis de saída

Nenhum.

Observações

O que há de novo na versão 1.0:

  • Suporta a nova CLI 2.0 do Azure que é baseada em Python
  • Funciona com agentes multiplataforma (Linux, macOS ou Windows)
  • Para trabalhar com a CLI do Azure 1.0 (baseada emnode.js), alterne para a versão de tarefa 0.0
  • Limitações: - Sem suporte para assinaturas do Azure Classic. A CLI 2.0 do Azure suporta apenas subscrições do Azure Resource Manager (ARM).

Requerimentos

Requisito Descrição
Tipos de pipeline YAML, Construção clássica, Versão clássica
Funciona em Agente, DeploymentGroup
Exigências Nenhum
Capacidades Esta tarefa não satisfaz quaisquer exigências 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 de tarefa Desplegar