Gestire la pipeline con l'interfaccia della riga di comando di Azure

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

È possibile gestire le pipeline nell'organizzazione usando questi az pipelines comandi:

Questi comandi richiedono il nome o l'ID della pipeline da gestire. È possibile ottenere l'ID di una pipeline usando il comando az pipelines list .

Per iniziare, vedere Introduzione all'interfaccia della riga di comando di Azure DevOps.

Eseguire una pipeline

È possibile accodamento (esecuzione) di una pipeline esistente con il comando az pipelines run .

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

Parametri

  • Branch: nome del ramo in cui l'esecuzione della pipeline deve essere accodato, ad esempio refs/heads/main.
  • commit-id: commit-id in cui l'esecuzione della pipeline deve essere accodata.
  • folder-path: percorso della cartella della pipeline. Il valore predefinito è la cartella a livello radice.
  • id: obbligatorio se il nome non è specificato. ID della pipeline da accodare.
  • name: obbligatorio se l'ID non viene fornito, ma ignorato se l'ID viene specificato. Nome della pipeline da accodare.
  • open: aprire la pagina dei risultati della pipeline nel Web browser.
  • org: URL dell'organizzazione di Azure DevOps. È possibile configurare l'organizzazione predefinita usando az devops configure -d organization=ORG_URL. Obbligatorio se non è configurato come predefinito o selezionato usando git config. Esempio: --org https://dev.azure.com/MyOrganizationName/.
  • progetto: nome o ID del progetto. È possibile configurare il progetto predefinito usando az devops configure -d project=NAME_OR_ID. Obbligatorio se non è configurato come predefinito o selezionato usando git config.
  • variabili: le coppie "name=value" separate dallo spazio per le variabili da impostare.

Esempio

Il comando seguente esegue la pipeline denominata myGithubname.pipelines-java nella pipeline di ramo e mostra il risultato in formato tabella.

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

Aggiornare una pipeline

È possibile aggiornare una pipeline esistente con il comando az pipelines update . Per iniziare, vedere Introduzione all'interfaccia della riga di comando di Azure DevOps.

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

Parametri

  • Branch: nome del ramo in cui deve essere configurata l'esecuzione della pipeline, ad esempio refs/heads/main.
  • descrizione: nuova descrizione per la pipeline.
  • id: obbligatorio se il nome non è specificato. ID della pipeline da aggiornare.
  • name: obbligatorio se l'ID non è specificato. Nome della pipeline da aggiornare.
  • new-folder-path: nuovo percorso completo della cartella a cui viene spostata la pipeline, ad esempio user1/production_pipelines.
  • new-name: nuovo nome aggiornato della pipeline.
  • org: URL dell'organizzazione di Azure DevOps. È possibile configurare l'organizzazione predefinita usando az devops configure -d organization=ORG_URL. Obbligatorio se non è configurato come predefinito o selezionato usando git config. Esempio: --org https://dev.azure.com/MyOrganizationName/.
  • progetto: nome o ID del progetto. È possibile configurare il progetto predefinito usando az devops configure -d project=NAME_OR_ID. Obbligatorio se non è configurato come predefinito o selezionato usando git config.
  • queue-id: ID coda del pool di agenti in cui deve essere eseguita la pipeline.
  • yaml-path: percorso del file yaml della pipeline nel repository.

I parametri globali includono debug, , queryhelponly-show-errors, output, e verbose.

Suggerimento

Esistono anche parametri globali che è possibile usare, --outputad esempio . Il --output parametro è disponibile per tutti i comandi. Il valore della tabella presenta l'output in un formato descrittivo. Per altre informazioni, vedere Formati di output per i comandi dell'interfaccia della riga di comando di Azure.

Esempio

Il comando seguente aggiorna la pipeline con l'ID 12 con un nuovo nome e una nuova descrizione e mostra il risultato in formato tabella.

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

Mostra pipeline

È possibile visualizzare i dettagli di una pipeline esistente con il comando az pipelines show . Per iniziare, vedere Introduzione all'interfaccia della riga di comando di Azure DevOps.

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

Parametri

  • folder-path: percorso della cartella della pipeline. Il valore predefinito è la cartella a livello radice.
  • id: obbligatorio se il nome non è specificato. ID della pipeline per visualizzare i dettagli.
  • name: obbligatorio se il nome non viene specificato, ma ignorato se viene specificato l'ID . Nome della pipeline per visualizzare i dettagli.
  • open: aprire la pagina di riepilogo della pipeline nel Web browser.
  • org: URL dell'organizzazione di Azure DevOps. È possibile configurare l'organizzazione predefinita usando az devops configure -d organization=ORG_URL. Obbligatorio se non è configurato come predefinito o selezionato usando git config. Esempio: --org https://dev.azure.com/MyOrganizationName/.
  • progetto: nome o ID del progetto. È possibile configurare il progetto predefinito usando az devops configure -d project=NAME_OR_ID. Obbligatorio se non è configurato come predefinito o selezionato usando git config.
  • esempi di query: consigliare una stringa JMESPath per l'utente.
  • sottoscrizione: nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Esempio

Il comando seguente mostra i dettagli della pipeline con l'ID 12 e restituisce il risultato in formato tabella.

az pipelines show --id 12 --output table

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

Passaggi successivi

È possibile personalizzare la pipeline o altre informazioni sulla configurazione delle pipeline nel linguaggio desiderato:

Domande frequenti

Ricerca per categorie creare una pipeline di compilazione a livello di codice?

Informazioni di riferimento sull'API REST: Creare una pipeline di compilazione

Nota

È anche possibile gestire le compilazioni e compilare pipeline dalla riga di comando o dagli script usando l'interfaccia della riga di comando di Azure Pipelines.

È possibile eseguire più pipeline in Azure DevOps Services usando un singolo comando?

Attualmente l'interfaccia della riga di comando di Azure e le API di Azure non offrono comandi che eseguono più pipeline dalla riga di comando. È possibile usare i comandi dell'interfaccia della riga di comando di Azure per elencare tutte le pipeline e le definizioni e fornire un singolo ID di rilascio o di compilazione come parametro. Tutti i comandi sono progettati per funzionare per esecuzioni indipendenti di pipeline indipendenti e richiedono richieste ID univoche che consentono un solo valore univoco. Per informazioni sui trigger della pipeline, vedere Specificare gli eventi che attivano le pipeline.