AzureCLI@1 – Azure CLI v1-uppgift

Artikel
03/24/2025

Kör Azure CLI-kommandon mot en Azure-prenumeration i ett gränssnittsskript när du kör på Linux-agenten eller batchskriptet när du kör på Windows-agenten.

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.

Ingångar

azureSubscription - Azure-prenumeration
Indataalias: connectedServiceNameARM. string. Obligatoriskt.

Väljer en Azure Resource Manager-prenumeration för distributionen.

scriptLocation - skriptplats
string. Obligatoriskt. Tillåtna värden: inlineScript (infogat skript), scriptPath (skriptsökväg). Standardvärde: scriptPath.

Väljer skriptplatsen.

scriptPath - skriptsökväg
string. Krävs när scriptLocation = scriptPath.

Fullständigt kvalificerad sökväg för skriptet eller en sökväg i förhållande till standardarbetskatalogen.

inlineScript - infogat skript
string. Krävs när scriptLocation = inlineScript.

Du kan skriva skripten infogat här. Använd batchskript när du använder Windows-agenten. Använd shell-skript när du använder Linux-baserade agenter. För batchfiler använder du prefixet call före varje Azure-kommando. Du kan också skicka fördefinierade och anpassade variabler till det här skriptet med hjälp av argument

Se följande exempel. Det första är ett gränssnittsexempel och det andra är ett batchexempel:

azure --version || azure account show

call  azure --version || call azure account show

arguments - argument
Indataalias: args. string.

Argument som skickas till skriptet.

addSpnToEnvironment - Åtkomst till tjänstens huvudnamn i skript
boolean. Standardvärde: false.

Lägger till tjänstens huvudnamns-ID och nyckeln för den Azure-slutpunkt som du valde i skriptets körningsmiljö. Du kan använda variablerna $servicePrincipalId och $servicePrincipalKey i skriptet.

Detta respekteras endast när Azure-slutpunkten har autentiseringsschema för tjänstens huvudnamn.

useGlobalConfig - Använd global Azure CLI-konfiguration
boolean. Standardvärde: false.

Om detta är falskt använder den här uppgiften en egen separat Azure CLI-konfigurationskatalog. Detta kan användas för att köra Azure CLI-uppgifter i parallella versioner.

workingDirectory - Arbetskatalog
Indataalias: cwd. string.

Aktuell arbetskatalog där skriptet körs. Om den lämnas tom är den här indata roten för lagringsplatsen (build) eller artefakter (version), som är $(System.DefaultWorkingDirectory).

failOnStandardError - fel vid standardfel
boolean. Standardvärde: false.

Om den här indatan är sann misslyckas den här aktiviteten när eventuella fel skrivs till StandardError-strömmen. Avmarkera kryssrutan för att ignorera standardfel och förlita dig i stället på slutkoder för att fastställa statusen.

Kontrollalternativ för aktivitet

Alla aktiviteter har kontrollalternativ utöver sina aktivitetsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Ingen.

Anmärkningar

Nyheter i version 1.0:

Stöder den nya Azure CLI 2.0 som är Python-baserad
Fungerar med plattformsoberoende agenter (Linux, macOS eller Windows)
Om du vill arbeta med Azure CLI 1.0 (node.js-based) växlar du till uppgiftsversion 0.0
Begränsningar: – Inget stöd för klassiska Azure-prenumerationer. Azure CLI 2.0 stöder endast Azure Resource Manager-prenumerationer (ARM).

Krav

Krav	Beskrivning
Pipelinetyper	YAML, klassisk version, klassisk version
Körs på	Agent, DeploymentGroup
kräver	Ingen
funktioner	Den här aktiviteten uppfyller inte några krav på efterföljande uppgifter i jobbet.
Kommandobegränsningar	Vilken som helst
variabler som kan	Vilken som helst
Agentversion	2.0.0 eller senare
Aktivitetskategori	Gruppera

Dela via