AzureCLI@1 - Azure CLI v1-taak

Artikel
07/02/2024

Voer Azure CLI-opdrachten uit op een Azure-abonnement in een shellscript wanneer deze wordt uitgevoerd op een Linux-agent of batchscript wanneer deze wordt uitgevoerd op een Windows-agent.

Voer een shell- of batchscript uit met Azure CLI-opdrachten voor een Azure-abonnement.

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.

Invoerwaarden

azureSubscription - Azure-abonnement
Invoeralias: connectedServiceNameARM. string. Vereist.

Selecteert een Azure Resource Manager-abonnement voor de implementatie.

scriptLocation - Scriptlocatie
string. Vereist. Toegestane waarden: inlineScript (Inlinescript), scriptPath (Scriptpad). Standaardwaarde: scriptPath.

Selecteert de locatie van het script.

scriptPath - Scriptpad
string. Vereist wanneer scriptLocation = scriptPath.

Volledig gekwalificeerd pad van het script of een pad ten opzichte van de standaardwerkmap.

inlineScript - Inlinescript
string. Vereist wanneer scriptLocation = inlineScript.

U kunt uw scripts hier inline schrijven. Wanneer u Windows-agent gebruikt, gebruikt u batchscripts. Gebruik shellscripts bij het gebruik van Op Linux gebaseerde agents. Gebruik voor batchbestanden het voorvoegsel call vóór elke Azure-opdracht. U kunt ook vooraf gedefinieerde en aangepaste variabelen aan dit script doorgeven met behulp van argumenten

Zie de volgende voorbeelden. De eerste is een shell-voorbeeld en de tweede is een batch-voorbeeld:

azure --version || azure account show

call  azure --version || call azure account show

arguments - Argumenten
Invoeralias: args. string.

Argumenten die aan het script zijn doorgegeven.

addSpnToEnvironment - Details van service-principal in script openen
boolean. Standaardwaarde: false.

Voegt de service-principal-id en sleutel van het Azure-eindpunt dat u hebt gekozen toe aan de uitvoeringsomgeving van het script. U kunt de $servicePrincipalId variabelen en $servicePrincipalKey gebruiken in uw script.

Dit wordt alleen gehonoreerd wanneer het Azure-eindpunt een service-principal-verificatieschema heeft.

useGlobalConfig - Globale Azure CLI-configuratie gebruiken
boolean. Standaardwaarde: false.

Als dit onwaar is, gebruikt deze taak een eigen afzonderlijke Azure CLI-configuratiemap. Dit kan worden gebruikt om Azure CLI-taken uit te voeren in parallelle releases.

workingDirectory - Werkmap
Invoeralias: cwd. string.

Huidige werkmap waarin het script wordt uitgevoerd. Als u dit veld leeg laat, is deze invoer de hoofdmap van de opslagplaats (build) of artefacten (release), namelijk $(System.DefaultWorkingDirectory).

failOnStandardError - Fout bij standaardfout
boolean. Standaardwaarde: false.

Als deze invoer waar is, mislukt deze taak wanneer er fouten naar de stream StandardError worden geschreven. Schakel het selectievakje uit om standaardfouten te negeren en gebruik in plaats daarvan afsluitcodes om de status te bepalen.

Opties voor taakbeheer

Alle taken hebben besturingsopties naast hun taakinvoer. Zie Opties voor besturingselementen en algemene taakeigenschappen voor meer informatie.

Uitvoervariabelen

Geen.

Opmerkingen

Wat is er nieuw in versie 1.0:

Ondersteunt de nieuwe Azure CLI 2.0 die is gebaseerd op Python
Werkt met platformoverschrijdende agents (Linux, macOS of Windows)
Als u wilt werken met Azure CLI 1.0 (op basis van node.js), schakelt u over naar taakversie 0.0
Beperkingen: geen ondersteuning voor klassieke Azure-abonnementen. Azure CLI 2.0 ondersteunt alleen ARM-abonnementen (Azure Resource Manager).

Vereisten

Vereiste	Beschrijving
Pijplijntypen	YAML, klassieke build, klassieke release
Wordt uitgevoerd op	Agent, DeploymentGroup
Eisen	Geen
Functies	Deze taak voldoet niet aan eventuele vereisten voor volgende taken in de taak.
Opdrachtbeperkingen	Alle
Instelbare variabelen	Alle
Agentversie	2.0.0 of hoger
Taakcategorie	Implementeren

Delen via