Partager via

Gérer des pipelines avec Azure DevOps CLI

  • Article

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

Cet article explique comment gérer des pipelines existants dans votre projet Azure DevOps à l’aide des commandes az pipelines suivantes :

Remarque

L’extension Azure DevOps CLI est disponible uniquement pour Azure DevOps Services et ne prend pas en charge une version d’Azure DevOps Server.

Extension d’interface de ligne de commande Azure DevOps

Le az-pipelines groupe de commandes fait partie de l’extension DevOps à Azure CLI, qui nécessite Azure CLI version 2.30.0 ou ultérieure. L’extension Azure DevOps installe automatiquement la première fois que vous exécutez une azure pipelines commande. Pour plus d’informations sur la prise en main, consultez Prise en main d’Azure DevOps CLI.

Vous pouvez également utiliser des paramètres Azure CLI globaux, tels que debug, , helponly-show-errors, queryoutputet , dans verbosevos commandes Azure DevOps CLI. La table valeur du paramètre global présente la --output sortie dans un format convivial. Pour plus d’informations, consultez Formats de sortie pour les commandes Azure CLI.

Vous pouvez définir l’organisation Azure DevOps par défaut pour les commandes CLI Azure DevOps à l’aide az devops configure --defaults organization=<YourOrganizationURL>de , ou utiliser le --detect true paramètre pour détecter automatiquement l’organisation. Vous pouvez configurer le projet Azure DevOps par défaut à l’aide az devops configure -d project=<Project Name or ID>de .

Si vous ne détectez pas l’organisation ou configurez une organisation ou un projet par défaut, ou que vous récupérez l’organisation et le projet via git config, vous devez spécifier les paramètres et project les org paramètres dans chaque commande.

Répertorier les pipelines existants

Les runcommandes , show, updateet delete pipeline nécessitent le name ou id le pipeline que vous souhaitez gérer. Si vous utilisez id, le name paramètre est ignoré. Pour obtenir la liste des pipelines de projet, y compris leurs ID, utilisez la commande az pipelines list . Vous pouvez filtrer ou mettre en forme la liste des résultats à l’aide de paramètres.

Par exemple, la commande suivante répertorie les pipelines de projet qui ont des noms commençant par python*, au format de tableau.

az pipelines list --name python* --output table

Sortie :

ID    Path    Name                        Status    Default Queue
----  ------  --------------------------  --------  ---------------
17    \       python-sample-vscode-flask  disabled  Azure Pipelines
24    \       python-sample-get-started   enabled   Azure Pipelines

Pour obtenir la référence de commande complète, consultez az pipelines list.

Afficher les détails d’un pipeline

Pour afficher les détails d’un pipeline existant, utilisez la commande az pipelines show . Par exemple, la commande suivante affiche les détails du pipeline avec le ID 12pipeline et ouvre la page récapitulative du pipeline dans votre navigateur web.

az pipelines show --id 12 --open

Pour obtenir la référence de commande complète, consultez az pipelines show.

Exécuter un pipeline

Pour mettre en file d’attente et exécuter un pipeline existant, utilisez la commande az pipelines run . Vous pouvez définir parameters et variables utiliser dans l’exécution.

Par exemple, la commande suivante exécute le pipeline avec name la myGithubname.pipelines-java pipeline branche, définit la valeur de la variable var1 pour 100 l’exécution et génère des résultats au table format.

az pipelines run --name myGithubname.pipelines-java --branch pipeline --variables var1=100 --output table

Sortie :

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

Pour obtenir la référence de commande complète, consultez az pipelines run.

Créer un pipeline

Pour mettre à jour un pipeline existant, utilisez la commande az pipelines update . Par exemple, la commande suivante met à jour le pipeline avec un id 12 nouveau nom et une nouvelle description, et génère le résultat au format de tableau.

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

Sortie :

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

Pour obtenir la référence de commande complète, consultez az pipelines update.

Supprimer un pipeline

Pour supprimer un pipeline, exécutez la commande az-pipelines-delete . Par exemple, la commande suivante supprime le pipeline avec l’ID de 12, et n’invite pas à confirmer. Si vous n’incluez pas le --yes paramètre, la commande invite à confirmer par défaut.

az pipelines delete --id 12 --yes

Pour obtenir la référence de commande complète, consultez az pipelines delete.

Créer et configurer des pipelines par programmation

Pour utiliser Azure DevOps CLI pour créer un pipeline YAML, consultez az pipelines create. Pour exécuter des commandes Azure CLI dans des pipelines YAML, consultez Azure DevOps CLI dans Azure Pipelines YAML.

Vous pouvez créer des pipelines YAML pour générer, configurer, tester et déployer des applications dans le langage de votre choix. Pour plus d’informations, consultez les articles suivants :

Azure DevOps Services REST API

Vous pouvez créer des applications ou des services personnalisés qui s’intègrent à Azure DevOps à l’aide des API REST pour effectuer des appels HTTP directs. Pour plus d’informations, consultez la référence de l’API REST Azure DevOps Services. Vous pouvez également utiliser les bibliothèques clientes pour ces API.

Ignorer une étape dans une exécution de pipeline

Vous pouvez utiliser la commande az rest avec l’API REST Exécuter le pipeline 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 Utiliser l’API REST Azure avec Azure CLI.

Contenu connexe