Delen via

Pijplijnen beheren met de Azure DevOps CLI

  • Artikel

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

In dit artikel wordt beschreven hoe u bestaande pijplijnen in uw Azure DevOps-project kunt beheren met behulp van de volgende az pipelines-opdrachten :

Notitie

De Azure DevOps CLI-extensie is alleen beschikbaar voor Azure DevOps Services en biedt geen ondersteuning voor een versie van Azure DevOps Server.

Azure DevOps CLI-extensie

De az-pipelines opdrachtgroep maakt deel uit van de DevOps-extensie voor de Azure CLI. Hiervoor is Versie 2.30.0 of hoger van Azure CLI vereist. De Azure DevOps-extensie wordt automatisch geïnstalleerd wanneer u een azure pipelines opdracht voor het eerst uitvoert. Zie Aan de slag met Azure DevOps CLI voor meer informatie over aan de slag.

U kunt ook globale Azure CLI-parameters gebruiken, zoals debug, help, only-show-errors, query, en outputverbose, in uw Azure DevOps CLI-opdrachten. De table waarde voor de --output globale parameter geeft uitvoer weer in een beschrijvende indeling. Zie Uitvoerindelingen voor Azure CLI-opdrachten voor meer informatie.

U kunt de standaard Azure DevOps-organisatie voor Azure DevOps CLI-opdrachten instellen met behulp van az devops configure --defaults organization=<YourOrganizationURL>, of de --detect true parameter gebruiken om de organisatie automatisch te detecteren. U kunt het standaard Azure DevOps-project configureren met behulp van az devops configure -d project=<Project Name or ID>.

Als u de organisatie niet detecteert of een standaardorganisatie of project configureert, of de organisatie en het project ophaalt via git config, moet u de org en project parameters in elke opdracht opgeven.

Bestaande pijplijnen weergeven

De runopdrachten voor , showen delete updatepijplijnen vereisen de name of id van de pijplijn die u wilt beheren. Als u deze gebruikt id, wordt de name parameter genegeerd. Gebruik de opdracht az pipelines list om een lijst met projectpijplijnen op te halen, inclusief hun id's. U kunt de lijst met resultaten filteren of opmaken met behulp van parameters.

Met de volgende opdracht worden bijvoorbeeld de projectpijplijnen weergegeven met namen die beginnen met python*, in tabelindeling.

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

Uitvoer:

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

Zie az pipelines list voor de volledige opdrachtreferentie.

Details voor een pijplijn weergeven

Gebruik de opdracht az pipelines show om de details van een bestaande pijplijn weer te geven. Met de volgende opdracht ziet u bijvoorbeeld de details van de pijplijn met de ID 12naam en opent u de overzichtspagina van de pijplijn in uw webbrowser.

az pipelines show --id 12 --open

Zie az pipelines show voor de volledige opdrachtreferentie.

Een pipeline uitvoeren

Gebruik de opdracht az pipelines run om een bestaande pijplijn in de wachtrij te plaatsen en uit te voeren. U kunt instellen parameters en variables gebruiken in de uitvoering.

Met de volgende opdracht wordt bijvoorbeeld de pijplijn uitgevoerd met in de vertakking, wordt de waarde van de variabele 100 var1 voor de uitvoering ingesteld en worden de uitvoerresultaten opgemaakttable.pipeline myGithubname.pipelines-java name

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

Uitvoer:

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

Zie az pipelines run voor de volledige opdrachtreferentie.

Een pijplijn bijwerken

Gebruik de opdracht az pipelines update om een bestaande pijplijn bij te werken. Met de volgende opdracht wordt bijvoorbeeld de pijplijn bijgewerkt met de id naam 12 en beschrijving en wordt het resultaat in tabelindeling uitgevoerd.

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

Uitvoer:

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

Zie az pipelines update voor de volledige opdrachtreferentie.

Een pijplijn verwijderen

Als u een pijplijn wilt verwijderen, voert u de opdracht az-pipelines-delete uit. Met de volgende opdracht wordt bijvoorbeeld de pijplijn verwijderd met de id van 12en wordt niet om bevestiging gevraagd. Als u de --yes parameter niet opneemt, wordt standaard om bevestiging gevraagd.

az pipelines delete --id 12 --yes

Zie az pipelines delete voor de volledige opdrachtreferentie.

Programmatisch pijplijnen maken en configureren

Als u de Azure DevOps CLI wilt gebruiken om een YAML-pijplijn te maken, raadpleegt u az pipelines create. Als u Azure CLI-opdrachten wilt uitvoeren in YAML-pijplijnen, raadpleegt u Azure DevOps CLI in Azure Pipelines YAML.

U kunt YAML-pijplijnen maken om apps te bouwen, configureren, testen en implementeren in de taal van uw keuze. Raadpleeg voor meer informatie de volgende artikelen:

Azure DevOps Services REST API

U kunt aangepaste toepassingen of services bouwen die zijn geïntegreerd met Azure DevOps met behulp van de REST API's om directe HTTP-aanroepen uit te voeren. Zie de naslaginformatie over de REST API van Azure DevOps Services voor meer informatie. U kunt ook de clientbibliotheken voor deze API's gebruiken.

Een fase in een pijplijnuitvoering overslaan

U kunt de az rest-opdracht gebruiken met de RUN Pipeline REST API om een fase in een pijplijnuitvoering over te slaan met behulp van de stagesToSkip parameter.

Voorbeeld:

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

Zie De Azure REST API gebruiken met Azure CLI voor meer informatie.

Gerelateerde inhoud