AzureCLI@1: Azure CLI v1-Aufgabe

Artikel
07/02/2024

Führen Sie Azure CLI-Befehle für ein Azure-Abonnement in einem Shellskript aus, wenn Sie auf einem Linux-Agent oder einem Batchskript ausgeführt werden, wenn Sie auf dem Windows-Agent ausgeführt werden.

Führen Sie eine Shell oder ein Batchskript mit Azure CLI-Befehlen für ein Azure-Abonnement aus.

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.

Eingaben

azureSubscription - Azure-Abonnement
Eingabealias: connectedServiceNameARM. string. Erforderlich.

Wählt ein Azure Resource Manager-Abonnement für die Bereitstellung aus.

scriptLocation - Skriptspeicherort
string. Erforderlich. Zulässige Werte: inlineScript (Inlineskript), scriptPath (Skriptpfad). Standardwert. scriptPath.

Wählt den Skriptspeicherort aus.

scriptPath - Skriptpfad
string. Erforderlich, wenn scriptLocation = scriptPath.

Vollqualifizierter Pfad des Skripts oder ein Pfad relativ zum Standardarbeitsverzeichnis.

inlineScript - Inlineskript
string. Erforderlich, wenn scriptLocation = inlineScript.

Sie können Ihre Skripts hier inline schreiben. Verwenden Sie bei Verwendung des Windows-Agents die Batchskripterstellung. Verwenden Sie Shellskripts, wenn Sie Linux-basierte Agents verwenden. Verwenden Sie für Batchdateien das Präfix call vor jedem Azure-Befehl. Sie können auch vordefinierte und benutzerdefinierte Variablen mithilfe von Argumenten an dieses Skript übergeben.

Weitere Informationen finden Sie in den folgenden Beispielen. Das erste ist ein Shellbeispiel und das zweite ein Batchbeispiel:

azure --version || azure account show

call  azure --version || call azure account show

arguments - Argumente
Eingabealias: args. string.

An das Skript übergebene Argumente.

addSpnToEnvironment - Zugreifen auf Dienstprinzipaldetails im Skript
boolean. Standardwert. false.

Fügt der Ausführungsumgebung des Skripts die Dienstprinzipal-ID und den Schlüssel des ausgewählten Azure-Endpunkts hinzu. Sie können die $servicePrincipalId Variablen und $servicePrincipalKey in Ihrem Skript verwenden.

Dies wird nur berücksichtigt, wenn es beim Azure-Endpunkt ein Dienstprinzipal-Authentifizierungsschema gibt.

useGlobalConfig - Verwenden der globalen Azure CLI-Konfiguration
boolean. Standardwert. false.

Wenn dies false ist, verwendet diese Aufgabe ein eigenes separates Azure CLI-Konfigurationsverzeichnis. Dies kann verwendet werden, um Azure CLI-Aufgaben in parallelen Releases auszuführen.

workingDirectory - Arbeitsverzeichnis
Eingabealias: cwd. string.

Aktuelles Arbeitsverzeichnis, in dem das Skript ausgeführt wird. Wenn diese Eingabe leer bleibt, ist diese Eingabe der Stamm des Repositorys (Build) oder der Artefakte (Release), also $(System.DefaultWorkingDirectory).

failOnStandardError - Fehler beim Standardfehler
boolean. Standardwert. false.

Wenn diese Eingabe true ist, schlägt diese Aufgabe fehl, wenn Fehler in den StandardError-Stream geschrieben werden. Deaktivieren Sie das Kontrollkästchen, um Standardfehler zu ignorieren, und verwenden Sie stattdessen Exitcodes, um die status zu bestimmen.

Optionen für die Vorgangskontrolle

Alle Vorgänge verfügen zusätzlich zu ihren Eingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerungsoptionen und allgemeine Aufgabeneigenschaften.

Ausgabevariablen

Keine.

Hinweise

Neuerungen in Version 1.0:

Unterstützt die neue Azure CLI 2.0, die auf Python basiert.
Funktioniert mit plattformübergreifenden Agents (Linux, macOS oder Windows)
Um mit Azure CLI 1.0 (node.js-basiert) zu arbeiten, wechseln Sie zur Aufgabenversion 0.0.
Einschränkungen: – Keine Unterstützung für klassische Azure-Abonnements. Azure CLI 2.0 unterstützt nur Azure Resource Manager-Abonnements (ARM).

Anforderungen

Anforderung	BESCHREIBUNG
Pipelinetypen	YAML, Klassischer Build, klassisches Release
Wird ausgeführt auf	Agent, DeploymentGroup
Forderungen	Keine
Capabilities	Diese Aufgabe erfüllt keine Anforderungen an nachfolgende Aufgaben im Auftrag.
Befehlseinschränkungen	Any
Setzbare Variablen	Any
Agent-Version	2.0.0 oder höher
Aufgabenkategorie	Bereitstellen

Freigeben über