AzureCLI@1 - Tarefa v1 da CLI do Azure

Artigo
07/02/2024

Execute comandos da CLI do Azure numa subscrição do Azure num script de shell quando estiver em execução no agente linux ou script de lote ao executar no agente do Windows.

Execute um script de shell ou batch com comandos da CLI do Azure numa subscrição 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 - Subscrição do Azure
Alias de entrada: connectedServiceNameARM. string. Obrigatório.

Seleciona uma subscrição do Azure Resource Manager para a implementação.

scriptLocation - Localização do Script
string. Obrigatório. Valores permitidos: inlineScript (Script inline), scriptPath (Caminho do script). Valor predefinido: scriptPath.

Seleciona a localização do script.

scriptPath - Caminho do Script
string. Necessário quando scriptLocation = scriptPath.

Caminho completamente qualificado do script ou um caminho relativo ao diretório de trabalho predefinido.

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

Pode escrever os seus scripts inline aqui. Ao utilizar o agente do Windows, utilize scripting em lote. Utilize scripting de shell ao utilizar agentes baseados em Linux. Para ficheiros batch, utilize o prefixo call antes de cada comando do Azure. Também pode transmitir variáveis predefinidas e personalizadas para este script com argumentos

Veja os seguintes exemplos: 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 transmitidos para o script.

addSpnToEnvironment - Aceder aos detalhes do principal de serviço no script
boolean. Valor predefinido: false.

Adiciona o ID e a chave do principal de serviço do ponto final do Azure que escolheu para o ambiente de execução do script. Pode utilizar as $servicePrincipalId variáveis e $servicePrincipalKey no script.

Isto só é respeitado quando o ponto final do Azure tem o esquema de autenticação do Principal de Serviço.

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

Se for falso, esta tarefa utilizará o seu próprio diretório de configuração da CLI do Azure separado. Isto pode ser utilizado 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 onde o script é executado. Se for deixada em branco, esta entrada é a raiz do repositório (compilação) ou dos artefactos (versão), que é $(System.DefaultWorkingDirectory).

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

Se esta entrada for verdadeira, esta tarefa falhará quando forem escritos erros no fluxo StandardError. Desmarque a caixa de verificação para ignorar erros padrão e, em vez disso, confie nos códigos de saída para determinar o estado.

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

Novidades na Versão 1.0:

Suporta a nova CLI 2.0 do Azure baseada em Python
Funciona com agentes multiplataformas (Linux, macOS ou Windows)
Para trabalhar com a CLI 1.0 do Azure (baseada em node.js), mude para a versão 0.0 da tarefa
Limitações: - Sem suporte para subscrições clássicas do Azure. A CLI 2.0 do Azure suporta apenas subscrições do Azure Resource Manager (ARM).

Requisitos

Requisito	Description
Tipos de pipeline	YAML, Compilação clássica, Versão clássica
É executado em	Agent, DeploymentGroup
Exigências	Nenhuma
Capacidades	Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa.
Restrições de comandos	Qualquer
Variáveis de definição	Qualquer
Versão do agente	2.0.0 ou superior
Categoria da tarefa	Implementação

Partilhar via