AzureCLI@1 - Attività dell'interfaccia della riga di comando di Azure v1

Articolo
06/11/2024

Eseguire i comandi dell'interfaccia della riga di comando di Azure su una sottoscrizione di Azure in uno script della shell durante l'esecuzione in un agente Linux o in uno script batch durante l'esecuzione nell'agente Di Windows.

Eseguire una shell o uno script batch con i comandi dell'interfaccia della riga di comando di Azure in una sottoscrizione di Azure.

Sintassi

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

Input

azureSubscription - Sottoscrizione di Azure
Alias di input: connectedServiceNameARM. string. Obbligatorio.

Seleziona una sottoscrizione di Azure Resource Manager per la distribuzione.

scriptLocation - Percorso script
string. Obbligatorio. Valori consentiti: inlineScript (script inline), scriptPath (percorso script). Valore predefinito: scriptPath.

Seleziona il percorso dello script.

scriptPath - Percorso script
string. Obbligatorio quando scriptLocation = scriptPath.

Percorso completo dello script o percorso relativo alla directory di lavoro predefinita.

inlineScript - Inline Script
string. Obbligatorio quando scriptLocation = inlineScript.

È possibile scrivere gli script inline qui. Quando si usa l'agente Di Windows, usare lo scripting batch. Usare script della shell quando si usano agenti basati su Linux. Per i file batch, usare il prefisso call prima di ogni comando di Azure. È anche possibile passare variabili predefinite e personalizzate a questo script usando argomenti

Vedere gli esempi seguenti. Il primo è un esempio di shell e il secondo è un esempio batch:

azure --version || azure account show

call  azure --version || call azure account show

arguments - Argomenti
Alias di input: args. string.

Argomenti passati allo script.

addSpnToEnvironment - Accedere ai dettagli dell'entità servizio nello script
boolean. Valore predefinito: false.

Aggiunge l'ID dell'entità servizio e la chiave dell'endpoint di Azure scelto per l'ambiente di esecuzione dello script. È possibile usare le $servicePrincipalId variabili e $servicePrincipalKey nello script.

Questo viene rispettato solo quando l'endpoint di Azure ha lo schema di autenticazione dell'entità servizio.

useGlobalConfig - Usare la configurazione dell'interfaccia della riga di comando di Azure globale
boolean. Valore predefinito: false.

Se si tratta di false, questa attività userà la propria directory di configurazione dell'interfaccia della riga di comando di Azure separata. Questa operazione può essere usata per eseguire attività dell'interfaccia della riga di comando di Azure nelle versioni parallele .

workingDirectory - Directory di lavoro
Alias di input: cwd. string.

Directory di lavoro corrente in cui viene eseguito lo script. Se lasciato vuoto, questo input è la radice del repository (build) o degli artefatti (versione), ovvero $(System.DefaultWorkingDirectory).

failOnStandardError - Errore standard non riuscita
boolean. Valore predefinito: false.

Se questo input è true, questa attività avrà esito negativo quando eventuali errori vengono scritti nel flusso StandardError. Deselezionare la casella di controllo per ignorare gli errori standard e invece basarsi sui codici di uscita per determinare lo stato.

Opzioni di controllo delle attività

Tutte le attività dispongono di opzioni di controllo oltre ai relativi input attività. Per altre informazioni, vedere Opzioni di controllo e proprietà comuni delle attività.

Variabili di output

Nessuno.

Osservazioni

Novità della versione 1.0:

Supporta la nuova interfaccia della riga di comando di Azure 2.0 basata su Python
Funziona con agenti multipiattaforma (Linux, macOS o Windows)
Per usare l'interfaccia della riga di comando di Azure 1.0 (basata su node.js), passare all'attività versione 0.0
Limitazioni: - Nessun supporto per le sottoscrizioni classiche di Azure. L'interfaccia della riga di comando di Azure 2.0 supporta solo le sottoscrizioni di Azure Resource Manager (ARM).

Requisiti

Requisito	Descrizione
Tipi di pipeline	YAML, build classica, versione classica
Esecuzione in	Agente, DeploymentGroup
Richieste	Nessuno
Capabilities	Questa attività non soddisfa le richieste per le attività successive nel processo.
Restrizioni dei comandi	Qualsiasi
Variabili impostabili	Qualsiasi
Versione agente	2.0.0 o versione successiva
Categoria attività	Distribuire

Condividi tramite