Dela via

Hantera pipelines med Azure DevOps CLI

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

Den här artikeln beskriver hur du kan hantera befintliga pipelines i ditt Azure DevOps-projekt med hjälp av följande az pipelines-kommandon :

Kommentar

Azure DevOps CLI-tillägget är endast tillgängligt för Azure DevOps Services och har inte stöd för någon version av Azure DevOps Server.

CLI-tillägg för Azure DevOps

Kommandogruppen az-pipelines är en del av DevOps-tillägget till Azure CLI, som kräver Azure CLI version 2.30.0 eller senare. Azure DevOps-tillägget installeras automatiskt första gången du kör ett azure pipelines kommando. Mer information om hur du kommer igång finns i Kom igång med Azure DevOps CLI.

Du kan också använda globala Azure CLI-parametrar, till exempel debug, help, only-show-errors, query, outputoch verbose, i dina Azure DevOps CLI-kommandon. Värdet table för den --output globala parametern visar utdata i ett vänligt format. Mer information finns i Utdataformat för Azure CLI-kommandon.

Du kan ange standardkommandona för Azure DevOps-organisationen för Azure DevOps CLI med hjälp az devops configure --defaults organization=<YourOrganizationURL>av eller använda parametern --detect true för att automatiskt identifiera organisationen. Du kan konfigurera Azure DevOps-standardprojektet med hjälp az devops configure -d project=<Project Name or ID>av .

Om du inte identifierar organisationen eller konfigurerar en standardorganisation eller ett standardprojekt eller hämtar organisationen och projektet via git configmåste du ange parametrarna org och project i varje kommando.

Lista befintliga pipelines

Kommandona run, show, update, och delete pipeline kräver antingen name eller id för den pipeline som du vill hantera. Om du använder idignoreras parametern name . Om du vill hämta en lista över projektpipelines, inklusive deras ID:n, använder du kommandot az pipelines list . Du kan filtrera eller formatera resultatlistan med hjälp av parametrar.

Följande kommando visar till exempel de projektpipelines som har namn som börjar med python*, i tabellformat.

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

Utdata:

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

Den fullständiga kommandoreferensen finns i az pipelines list.

Visa information för en pipeline

Om du vill visa information om en befintlig pipeline använder du kommandot az pipelines show . Följande kommando visar till exempel information om pipelinen med ID i 12och öppnar pipelinesammanfattningssidan i webbläsaren.

az pipelines show --id 12 --open

Den fullständiga kommandoreferensen finns i az pipelines show.

Kör en pipeline

Om du vill köa och köra en befintlig pipeline använder du kommandot az pipelines run . Du kan ange parameters och variables att använda i körningen.

Följande kommando kör till exempel pipelinen i grenen name med myGithubname.pipelines-java och pipeline, anger värdet för variabeln var1 till 100 för körningen och skriver ut resultat i table-format.

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

Utdata:

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

För den fullständiga kommandoreferensen, se az pipelines run.

Uppdatera en pipeline

Om du vill uppdatera en befintlig pipeline använder du kommandot az pipelines update . Följande kommando uppdaterar till exempel pipelinen id12 med ett nytt namn och en ny beskrivning, och resultatet matas ut i tabellformat.

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

Utdata:

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

Den fullständiga kommandoreferensen finns i az pipelines update.

Ta bort en pipeline

Om du vill ta bort en pipeline kör du kommandot az-pipelines-delete . Följande kommando tar till exempel bort pipelinen med ID 12 och frågar inte efter bekräftelse. Om du inte inkluderar parametern --yes, kommer kommandot att be om bekräftelse som standard.

az pipelines delete --id 12 --yes

Den fullständiga kommandoreferensen finns i az pipelines delete.

Skapa och konfigurera pipelines programmatiskt

Information om hur du använder Azure DevOps CLI för att skapa en YAML-pipeline finns i az pipelines create. Information om hur du kör Azure CLI-kommandon i YAML-pipelines finns i Azure DevOps CLI i Azure Pipelines YAML.

Du kan skapa YAML-pipelines för att skapa, konfigurera, testa och distribuera appar på valfritt språk. Mer information finns i följande artiklar:

Azure DevOps Services REST API

Du kan skapa anpassade program eller tjänster som integreras med Azure DevOps med hjälp av REST-API:erna för att göra direkta HTTP-anrop. Mer information finns i REST API-referensen för Azure DevOps Services. Du kan också använda klientbiblioteken för dessa API:er.

Hoppa över en fas i en pipelinekörning

Du kan använda kommandot az rest med Kör pipeline REST API:en för att hoppa över ett steg 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 Använda Azure REST API med Azure CLI.

Relaterat innehåll