Hantera din pipeline med Azure CLI

  • Artikel

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

Du kan hantera pipelines i din organisation med hjälp av följande az pipelines kommandon:

Dessa kommandon kräver antingen namnet eller ID:t för den pipeline som du vill hantera. Du kan hämta ID:t för en pipeline med kommandot az pipelines list .

Kom igång genom att läsa Komma igång med Azure DevOps CLI.

Kör en pipeline

Du kan köa (köra) en befintlig pipeline med kommandot az pipelines run .

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

Parametrar

  • gren: Namnet på den gren där pipelinekörningen ska placeras i kö, till exempel refs/heads/main.
  • commit-id: Inchecknings-ID som pipelinekörningen ska placeras i kö på.
  • mappsökväg: Mappsökväg för pipeline. Standard är mappen på rotnivå.
  • ID: Krävs om namnet inte anges. ID för pipelinen som ska köas.
  • name: Krävs om ID inte tillhandahålls, men ignoreras om ID anges. Namnet på pipelinen som ska köas.
  • öppna: Öppna pipelineresultatsidan i webbläsaren.
  • org: Url för Azure DevOps-organisationen. Du kan konfigurera standardorganisationen med .az devops configure -d organization=ORG_URL Krävs om det inte är konfigurerat som standard eller hämtas med hjälp av git config. Exempel: --org https://dev.azure.com/MyOrganizationName/.
  • project: Projektets namn eller ID. Du kan konfigurera standardprojektet med .az devops configure -d project=NAME_OR_ID Krävs om det inte är konfigurerat som standard eller hämtas med hjälp av git config.
  • variabler: Blankstegsavgränsade "name=value"-par för de variabler som du vill ange.

Exempel

Följande kommando kör pipelinen myGithubname.pipelines-java i grenpipelinen och visar resultatet i tabellformat.

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

Uppdatera en pipeline

Du kan uppdatera en befintlig pipeline med kommandot az pipelines update . Kom igång genom att läsa Komma igång med Azure DevOps CLI.

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

Parametrar

  • gren: Namnet på den gren där pipelinekörningen ska konfigureras, till exempel refs/heads/main.
  • description: Ny beskrivning för pipelinen.
  • ID: Krävs om namnet inte anges. ID för pipelinen som ska uppdateras.
  • name: Krävs om ID inte har angetts. Namnet på pipelinen som ska uppdateras.
  • new-folder-path: Ny fullständig sökväg för mappen som pipelinen flyttas till, till exempel user1/production_pipelines.
  • new-name: Nytt uppdaterat namn på pipelinen.
  • org: Url för Azure DevOps-organisationen. Du kan konfigurera standardorganisationen med .az devops configure -d organization=ORG_URL Krävs om det inte är konfigurerat som standard eller hämtas med hjälp av git config. Exempel: --org https://dev.azure.com/MyOrganizationName/.
  • project: Projektets namn eller ID. Du kan konfigurera standardprojektet med .az devops configure -d project=NAME_OR_ID Krävs om det inte är konfigurerat som standard eller hämtas med hjälp av git config.
  • queue-id: Kö-ID för agentpoolen där pipelinen behöver köras.
  • yaml-path: Sökvägen till pipelinens yaml-fil på lagringsplatsen.

Globala parametrar är debug, help, only-show-errors, query, outputoch verbose.

Dricks

Det finns även globala parametrar som du kan använda, till exempel --output. Parametern --output är tillgänglig för alla kommandon. Tabellvärdet visar utdata i ett eget format. Mer information finns i Utdataformat för Azure CLI-kommandon.

Exempel

Följande kommando uppdaterar pipelinen med ID:t 12 med ett nytt namn och en ny beskrivning och visar resultatet i tabellformat.

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

Visa pipeline

Du kan visa information om en befintlig pipeline med kommandot az pipelines show . Kom igång genom att läsa Komma igång med Azure DevOps CLI.

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

Parametrar

  • mappsökväg: Mappsökväg för pipeline. Standard är mappen på rotnivå.
  • ID: Krävs om namnet inte anges. ID för pipelinen för att visa information.
  • name: Krävs om namnet inte anges, men ignoreras om ID anges. Namnet på pipelinen för att visa information.
  • öppna: Öppna sammanfattningssidan för pipelinen i webbläsaren.
  • org: Url för Azure DevOps-organisationen. Du kan konfigurera standardorganisationen med .az devops configure -d organization=ORG_URL Krävs om det inte är konfigurerat som standard eller hämtas med hjälp av git config. Exempel: --org https://dev.azure.com/MyOrganizationName/.
  • project: Projektets namn eller ID. Du kan konfigurera standardprojektet med .az devops configure -d project=NAME_OR_ID Krävs om det inte är konfigurerat som standard eller hämtas med hjälp av git config.
  • frågeexempel: Rekommendera en JMESPath-sträng åt dig.
  • prenumeration: Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Exempel

Följande kommando visar information om pipelinen med ID :t 12 och returnerar resultatet i tabellformat.

az pipelines show --id 12 --output table

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

Nästa steg

Du kan anpassa din pipeline eller lära dig mer om hur du konfigurerar pipelines på valfritt språk:

Vanliga frågor

Hur skapar jag programmatiskt en byggpipeline?

REST API-referens: Skapa en bygg-pipeline

Kommentar

Du kan också hantera byggen och skapa pipelines från kommandoraden eller skripten med hjälp av Azure Pipelines CLI.

Kan jag köra flera pipelines i Azure DevOps Services med ett enda kommando?

För närvarande erbjuder inte Azure CLI- och Azure-API:erna kommandon som kör flera pipelines från kommandoraden. Du kan använda Azure CLI-kommandon för att lista alla pipelines och definitioner och ange ett enda versions- eller bygg-ID som en parameter. Alla kommandon är utformade för att fungera för oberoende körningar av oberoende pipelines, och de kräver unika ID-begäranden som endast tillåter ett unikt värde. Mer information om pipelineutlösare finns i Ange händelser som utlöser pipelines.

Hur hoppar jag över en fas i en pipelinekörning?

Du kan använda az rest kommandot för att använda Rest-API:et run pipeline för Azure DevOps för att hoppa över en fas i en pipelinekörning med hjälp av parametern stagesToSkip .

Till exempel:

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

Mer information finns i REST API-referens för Azure DevOps Services.