Gérer votre pipeline avec Azure CLI

  • Article

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2020

Vous pouvez gérer les pipelines de votre organisation à l’aide de ces commandes az pipelines :

Ces commandes nécessitent le nom ou l’ID du pipeline que vous souhaitez gérer. Vous pouvez obtenir l’ID d’un pipeline à l’aide de la commande az pipelines list.

Pour commencer, consultez Bien démarrer avec l’interface CLI Azure DevOps.

Exécuter un pipeline

Vous pouvez mettre en file d’attente (exécuter) un pipeline existant avec la commande az pipelines run.

az pipelines run [--branch]
                 [--commit-id]
                 [--folder-path]
                 [--id]
                 [--name]
                 [--open]
                 [--org]
                 [--project]
                 [--variables]

Paramètres

  • branche : nom de la branche sur laquelle l’exécution du pipeline doit être mise en file d’attente, par exemple, refs/heads/main.
  • commit-id : ID de validation sur lequel l’exécution du pipeline doit être mise en file d’attente.
  • folder-path : chemin d’accès au dossier du pipeline. La valeur par défaut est le dossier de niveau racine.
  • ID : Obligatoire si le nom n’est pas fourni. ID du pipeline à mettre en file d’attente.
  • nom : Obligatoire si l’ID n’est pas fourni, mais ignoré si l’ID est fourni. Nom du pipeline à mettre en file d’attente.
  • ouvrir : ouvrez la page des résultats du pipeline dans votre navigateur web.
  • org : URL de l’organisation Azure DevOps. Vous pouvez configurer l’organisation par défaut à l’aide de az devops configure -d organization=ORG_URL. Obligatoire en l’absence d’une configuration par défaut ou d’une récupération à l’aide de git config. Exemple : --org https://dev.azure.com/MyOrganizationName/.
  • projet : nom ou ID du projet. Vous pouvez configurer le projet par défaut en utilisant az devops configure -d project=NAME_OR_ID. Obligatoire en l’absence d’une configuration par défaut ou d’une récupération à l’aide de git config.
  • variables : paires « name=value » séparées par des espaces pour les variables que vous souhaitez définir.

Exemple

La commande suivante exécute le pipeline nommé myGithubname.pipelines-java dans le pipeline de branche et affiche le résultat au format de table.

az pipelines run --name myGithubname.pipelines-java --branch pipeline --output table

Run ID    Number      Status      Result    Pipeline ID    Pipeline Name                Source Branch    Queued Time               Reason
--------  ----------  ----------  --------  -------------  ---------------------------  ---------------  --------------------------  --------
123       20200123.2  notStarted            12             myGithubname.pipelines-java  pipeline           2020-01-23 11:55:56.633450  manual

Créer un pipeline

Vous pouvez mettre à jour un pipeline existant avec la commande az pipelines update. Pour commencer, consultez Bien démarrer avec l’interface CLI Azure DevOps.

az pipelines update [--branch]
                    [--description]
                    [--id]
                    [--name]
                    [--new-folder-path]
                    [--new-name]
                    [--org]
                    [--project]
                    [--queue-id]
                    [--yaml-path]

Paramètres

  • branche : nom de la branche sur laquelle l’exécution du pipeline doit être configurée, par exemple, refs/heads/main.
  • description : Nouvelle description du pipeline.
  • ID : Obligatoire si le nom n’est pas fourni. ID du pipeline à mettre à jour.
  • nom : obligatoire si l’ID n’est pas fourni. Nom du pipeline à mettre à jour.
  • new-folder-path : nouveau chemin complet du dossier dans lequel le pipeline est déplacé, par exemple, user1/production_pipelines.
  • new-name : Nouveau nom mis à jour du pipeline.
  • org : URL de l’organisation Azure DevOps. Vous pouvez configurer l’organisation par défaut à l’aide de az devops configure -d organization=ORG_URL. Obligatoire en l’absence d’une configuration par défaut ou d’une récupération à l’aide de git config. Exemple : --org https://dev.azure.com/MyOrganizationName/.
  • projet : nom ou ID du projet. Vous pouvez configurer le projet par défaut en utilisant az devops configure -d project=NAME_OR_ID. Obligatoire en l’absence d’une configuration par défaut ou d’une récupération à l’aide de git config.
  • queue-id : ID de file d’attente du pool d’agents où le pipeline doit s’exécuter.
  • yaml-path : chemin d’accès du fichier yaml du pipeline dans le référentiel.

Les paramètres globaux comprennent debug, help, only-show-errors, query, output, et verbose.

Conseil

Il existe également des paramètres globaux que vous pouvez utiliser tels que --output. Le paramètre --output est disponible pour toutes les commandes. La valeur table présente la sortie dans un format convivial. Pour plus d’informations, consultez Formats de sortie pour les commandes Azure CLI.

Exemple

La commande suivante met à jour le pipeline avec l’ID 12 avec un nouveau nom et une nouvelle description et affiche le résultat sous forme de tableau.

az pipelines update --id 12 --description "rename pipeline" --new-name updatedname.pipelines-java --output table

ID    Name                        Status    Default Queue
----  --------------------------  --------  ------------------
12    updatedname.pipelines-java  enabled   Hosted Ubuntu 1604

Afficher le pipeline

Vous pouvez afficher les détails d’un pipeline existant avec la commande az pipelines show. Pour commencer, consultez Bien démarrer avec l’interface CLI Azure DevOps.

az pipelines show [--folder-path]
                  [--id]
                  [--name]
                  [--open]
                  [--org]
                  [--project]
                  [--query-examples]
                  [--subscription]

Paramètres

  • folder-path : chemin d’accès au dossier du pipeline. La valeur par défaut est le dossier de niveau racine.
  • ID : Obligatoire si le nom n’est pas fourni. ID du pipeline pour afficher les détails.
  • nom : obligatoire si le nom n’est pas fourni, mais ignoré si l’ID est fourni. Nom du pipeline pour afficher les détails.
  • ouvert : ouvrez la page de résumé du pipeline dans votre navigateur web.
  • org : URL de l’organisation Azure DevOps. Vous pouvez configurer l’organisation par défaut à l’aide de az devops configure -d organization=ORG_URL. Obligatoire en l’absence d’une configuration par défaut ou d’une récupération à l’aide de git config. Exemple : --org https://dev.azure.com/MyOrganizationName/.
  • projet : nom ou ID du projet. Vous pouvez configurer le projet par défaut en utilisant az devops configure -d project=NAME_OR_ID. Obligatoire en l’absence d’une configuration par défaut ou d’une récupération à l’aide de git config.
  • exemples de requête : recommandez une chaîne JMESPath pour vous.
  • --subscription : nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Exemple

La commande suivante affiche les détails du pipeline avec l’ID 12 et retourne le résultat sous forme de tableau.

az pipelines show --id 12 --output table

ID    Name                        Status    Default Queue
----  --------------------------  --------  ------------------
12    updatedname.pipelines-java  enabled   Hosted Ubuntu 1604

Étapes suivantes

Vous pouvez personnaliser votre pipeline ou en savoir plus sur la configuration des pipelines dans la langue de votre choix :

Questions fréquentes (FAQ)

Comment créer un pipeline de build par programmation ?

Informations de référence sur l’API REST : Créer un pipeline de build

Remarque

Vous pouvez également gérer les builds et générer des pipelines à partir de la ligne de commande ou des scripts à l’aide d’Azure Pipelines CLI.

Puis-je exécuter plusieurs pipelines dans Azure DevOps Services à l’aide d’une seule commande ?

Actuellement, Azure CLI et les API Azure ne proposent pas de commandes qui exécutent plusieurs pipelines à partir de la ligne de commande. Vous pouvez utiliser des commandes Azure CLI pour répertorier tous les pipelines et définitions et fournir un ID de mise en production ou de build unique en tant que paramètre. Toutes les commandes sont conçues pour fonctionner pour des exécutions indépendantes de pipelines indépendants et nécessitent des demandes d’ID uniques qui n’autorisent qu’une seule valeur unique. Pour en savoir plus sur les déclencheurs de pipeline, consultez Spécifier des événements qui déclenchent des pipelines.

Comment faire ignorer une étape dans une exécution de pipeline ?

Vous pouvez utiliser la az rest commande pour utiliser l’API run pipeline REST Azure DevOps pour ignorer une étape dans une exécution de pipeline à l’aide du stagesToSkip paramètre.

Par exemple :

az rest --method post `
    --uri https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1-preview.1 `
    --body "{'stagesToSkip': [''], 'resources': {'repositories': {'self': {'refName': 'refs/heads/{branch}'}}}}" `
    --resource 499b84ac-1321-427f-aa17-267ca6975798

Pour plus d’informations, consultez informations de référence sur l’API REST Azure DevOps Services.