Freigeben über


AzureCLI@1 – Azure CLI v1-Aufgabe

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

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.

Eingänge

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 eines Pfads relativ zum Standardarbeitsverzeichnis.


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

Hier können Sie Ihre Skripts inline schreiben. Verwenden Sie bei Verwendung des Windows-Agents Batchskripting. Verwenden Sie Shellskripting bei Verwendung von Linux-basierten Agents. 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.

Siehe folgende Beispiele: Die erste ist ein Shellbeispiel, und die zweite ist ein Batchbeispiel:

azure --version || azure account show 
call  azure --version || call azure account show

arguments - Argumente
Eingabealias: args. string.

Argumente, die an das Skript übergeben werden.


addSpnToEnvironment - Details des Access-Dienstprinzipals in Skript-
boolean. Standardwert: false.

Fügt die Dienstprinzipal-ID und den Schlüssel des Azure-Endpunkts hinzu, den Sie der Ausführungsumgebung des Skripts ausgewählt haben. Sie können die variablen $servicePrincipalId 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 falsch ist, verwendet diese Aufgabe ein eigenes separates Azure CLI-Konfigurationsverzeichnis. Dies kann verwendet werden, um Azure CLI-Aufgaben in parallelen-Versionen auszuführen.


workingDirectory - Arbeitsverzeichnis-
Eingabealias: cwd. string.

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


failOnStandardError - fehler bei Standardfehler-
boolean. Standardwert: false.

Wenn diese Eingabe zutrifft, schlägt diese Aufgabe fehl, wenn Fehler in den StandardError-Datenstrom geschrieben werden. Deaktivieren Sie das Kontrollkästchen, um Standardfehler zu ignorieren, und verlassen Sie sich stattdessen auf Exitcodes, um den Status zu ermitteln.


Aufgabensteuerungsoptionen

Alle Aufgaben verfügen zusätzlich zu ihren Aufgabeneingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerelementoptionen und allgemeinen Aufgabeneigenschaften.

Ausgabevariablen

Keiner.

Bemerkungen

Neuerungen in Version 1.0:

  • Unterstützt die neue Azure CLI 2.0, die Python basiert
  • Arbeitet 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 Azure Classic-Abonnements. Azure CLI 2.0 unterstützt nur Azure Resource Manager (ARM)-Abonnements.

Anforderungen

Anforderung BESCHREIBUNG
Pipelinetypen YAML, Classic Build, Classic Release
Läuft auf Agent, DeploymentGroup
Anforderungen Nichts
Funktionen Dieser Vorgang erfüllt keine Anforderungen für nachfolgende Vorgänge im Auftrag.
Befehlseinschränkungen Jegliche
Settable-Variablen Jegliche
Agentversion 2.0.0 oder höher
Vorgangskategorie Einsetzen