AzureCLI@1 - Tâche Azure CLI v1

Article
05/16/2024

Exécutez des commandes Azure CLI sur un abonnement Azure dans un script shell lors de l’exécution sur l’agent Linux ou un script par lots lors de l’exécution sur l’agent Windows.

Exécutez un interpréteur de commandes ou un script par lots avec des commandes Azure CLI sur un abonnement Azure.

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.

Entrées

azureSubscription - Abonnement Azure
Alias d’entrée : connectedServiceNameARM. string. Obligatoire.

Sélectionne un abonnement Azure Resource Manager pour le déploiement.

scriptLocation - Emplacement du script
string. Obligatoire. Valeurs autorisées : inlineScript (script inline), scriptPath (chemin du script). Valeur par défaut : scriptPath.

Sélectionne l’emplacement du script.

scriptPath - Chemin du script
string. Nécessaire lorsque scriptLocation = scriptPath.

Chemin complet du script ou chemin d’accès relatif au répertoire de travail par défaut.

inlineScript - Inline Script
string. Nécessaire lorsque scriptLocation = inlineScript.

Vous pouvez écrire vos scripts en ligne ici. Lorsque vous utilisez l’agent Windows, utilisez des scripts par lots. Utilisez des scripts d’interpréteur de commandes lors de l’utilisation d’agents linux. Pour les fichiers batch, utilisez le préfixe call avant chaque commande Azure. Vous pouvez également passer des variables prédéfinies et personnalisées à ce script à l’aide d’arguments

Consultez les exemples suivants. Le premier est un exemple d’interpréteur de commandes et le second est un exemple de lot :

azure --version || azure account show

call  azure --version || call azure account show

arguments - Arguments
Alias d’entrée : args. string.

Arguments passés au script.

addSpnToEnvironment - Accéder aux détails du principal du service dans le script
boolean. Valeur par défaut : false.

Ajoute l’ID de principal de service et la clé du point de terminaison Azure que vous avez choisi à l’environnement d’exécution du script. Vous pouvez utiliser les $servicePrincipalId variables et $servicePrincipalKey dans votre script.

Cela est respecté uniquement lorsque le point de terminaison Azure a le schéma d’authentification du principal de service.

useGlobalConfig - Utiliser la configuration globale d’Azure CLI
boolean. Valeur par défaut : false.

Si cette valeur est false, cette tâche utilise son propre répertoire de configuration Azure CLI distinct. Cela peut être utilisé pour exécuter des tâches Azure CLI dans des versions parallèles .

workingDirectory - Répertoire de travail
Alias d’entrée : cwd. string.

Répertoire de travail actuel où le script est exécuté. Si elle n’est pas renseignée, cette entrée est la racine du référentiel (build) ou des artefacts (version), qui est $(System.DefaultWorkingDirectory).

failOnStandardError - Échec en cas d’erreur standard
boolean. Valeur par défaut : false.

Si cette entrée a la valeur true, cette tâche échoue lorsque des erreurs sont écrites dans le flux StandardError. Désactivez la case à cocher pour ignorer les erreurs standard et utiliser plutôt les codes de sortie pour déterminer les status.

Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

Nouveautés de la version 1.0 :

Prend en charge la nouvelle version d’Azure CLI 2.0 basée sur Python
Fonctionne avec des agents multiplateformes (Linux, macOS ou Windows)
Pour utiliser Azure CLI 1.0 (basé sur node.js), basculez vers la version de tâche 0.0
Limitations : - Aucune prise en charge des abonnements Azure Classic. Azure CLI 2.0 prend uniquement en charge les abonnements Azure Resource Manager (ARM).

Configuration requise

Condition requise	Description
Types de pipelines	YAML, build classique, version classique
S’exécute sur	Agent, DeploymentGroup
Demandes	None
Capabilities	Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commandes	Quelconque
Variables settables	Quelconque
Version de l’agent	2.0.0 ou supérieur
Catégorie de la tâche	Déployer

Share via