Share via

Uw pijplijn beheren met Azure CLI

  • Artikel

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

U kunt de pijplijnen in uw organisatie beheren met behulp van deze az pipelines opdrachten:

Voor deze opdrachten is de naam of id van de pijplijn vereist die u wilt beheren. U kunt de id van een pijplijn ophalen met behulp van de opdracht az pipelines list .

Zie Aan de slag met Azure DevOps CLI om aan de slag te gaan.

Een pipeline uitvoeren

U kunt een bestaande pijplijn in de wachtrij plaatsen (uitvoeren) met de opdracht az pipelines run .

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

Parameters

  • branch: Naam van de vertakking waarop de pijplijnuitvoering moet worden geplaatst, bijvoorbeeld refs/heads/main.
  • commit-id: doorvoer-id waarop de pijplijnuitvoering in de wachtrij moet worden geplaatst.
  • mappad: mappad van de pijplijn. De standaardmap is de hoofdmap.
  • id: Vereist als de naam niet is opgegeven. Id van de pijplijn naar wachtrij.
  • naam: Vereist als de id niet is opgegeven, maar wordt genegeerd als de id is opgegeven. Naam van de pijplijn die in de wachtrij moet worden geplaatst.
  • open: Open de pagina met pijplijnresultaten in uw webbrowser.
  • organisatie: URL van Azure DevOps-organisatie. U kunt de standaardorganisatie configureren met behulp van az devops configure -d organization=ORG_URL. Vereist als deze niet is geconfigureerd als standaard of wordt opgehaald met behulp van git config. Voorbeeld: --org https://dev.azure.com/MyOrganizationName/.
  • project: naam of id van het project. U kunt het standaardproject configureren met behulp van az devops configure -d project=NAME_OR_ID. Vereist als deze niet is geconfigureerd als standaard of wordt opgehaald met behulp van git config.
  • variabelen: door spatie gescheiden paren "name=value" voor de variabelen die u wilt instellen.

Opmerking

Met de volgende opdracht wordt de pijplijn met de naam myGithubname.pipelines-java uitgevoerd in de vertakkingspijplijn en wordt het resultaat in tabelindeling weergegeven.

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

Een pijplijn bijwerken

U kunt een bestaande pijplijn bijwerken met de opdracht az pipelines update . Zie Aan de slag met Azure DevOps CLI om aan de slag te gaan.

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

Parameters

  • branch: Naam van de vertakking waarop de pijplijnuitvoering moet worden geconfigureerd, bijvoorbeeld refs/heads/main.
  • beschrijving: Nieuwe beschrijving voor de pijplijn.
  • id: Vereist als de naam niet is opgegeven. Id van de pijplijn die moet worden bijgewerkt.
  • name: Vereist als id niet is opgegeven. Naam van de pijplijn die moet worden bijgewerkt.
  • new-folder-path: Nieuw volledig pad van de map waarnaar de pijplijn wordt verplaatst, bijvoorbeeld gebruiker1/production_pipelines.
  • nieuwe naam: nieuwe bijgewerkte naam van de pijplijn.
  • organisatie: URL van Azure DevOps-organisatie. U kunt de standaardorganisatie configureren met behulp van az devops configure -d organization=ORG_URL. Vereist als deze niet is geconfigureerd als standaard of wordt opgehaald met behulp van git config. Voorbeeld: --org https://dev.azure.com/MyOrganizationName/.
  • project: naam of id van het project. U kunt het standaardproject configureren met behulp van az devops configure -d project=NAME_OR_ID. Vereist als deze niet is geconfigureerd als standaard of wordt opgehaald met behulp van git config.
  • queue-id: Wachtrij-id van de agentgroep waar de pijplijn moet worden uitgevoerd.
  • yaml-path: pad van het yaml-bestand van de pijplijn in de opslagplaats.

Globale parameters omvattendebug, help, , only-show-errors, query, en verboseoutput.

Tip

Er zijn ook globale parameters die u kunt gebruiken, zoals --output. De --output parameter is beschikbaar voor alle opdrachten. De tabelwaarde geeft uitvoer weer in een beschrijvende indeling. Zie Uitvoerindelingen voor Azure CLI-opdrachten voor meer informatie.

Opmerking

Met de volgende opdracht wordt de pijplijn bijgewerkt met de id 12 met een nieuwe naam en beschrijving en wordt het resultaat in tabelindeling weergegeven.

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

Pijplijn weergeven

U kunt de details van een bestaande pijplijn bekijken met de opdracht az pipelines show . Zie Aan de slag met Azure DevOps CLI om aan de slag te gaan.

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

Parameters

  • mappad: mappad van de pijplijn. De standaardmap is de hoofdmap.
  • id: Vereist als de naam niet is opgegeven. Id van de pijplijn om details weer te geven.
  • name: Vereist als de naam niet is opgegeven, maar wordt genegeerd als de id is opgegeven. Naam van de pijplijn om details weer te geven.
  • open: Open de overzichtspagina van de pijplijn in uw webbrowser.
  • organisatie: URL van Azure DevOps-organisatie. U kunt de standaardorganisatie configureren met behulp van az devops configure -d organization=ORG_URL. Vereist als deze niet is geconfigureerd als standaard of wordt opgehaald met behulp van git config. Voorbeeld: --org https://dev.azure.com/MyOrganizationName/.
  • project: naam of id van het project. U kunt het standaardproject configureren met behulp van az devops configure -d project=NAME_OR_ID. Vereist als deze niet is geconfigureerd als standaard of wordt opgehaald met behulp van git config.
  • queryvoorbeelden: Een JMESPath-tekenreeks voor u aanbevelen.
  • abonnement: naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Opmerking

De volgende opdracht toont de details van de pijplijn met de id van 12 en retourneert het resultaat in tabelindeling.

az pipelines show --id 12 --output table

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

Volgende stappen

U kunt uw pijplijn aanpassen of meer informatie over het configureren van pijplijnen in de taal van uw keuze:

Veelgestelde vragen

Hoe kan ik programmatisch een build-pijplijn maken?

REST API-naslaginformatie: een build-pijplijn maken

Notitie

U kunt ook builds en build-pijplijnen beheren vanaf de opdrachtregel of scripts met behulp van de Azure Pipelines CLI.

Kan ik meerdere pijplijnen uitvoeren in Azure DevOps Services met één opdracht?

Momenteel bieden de Azure CLI en Azure-API's geen opdrachten die meerdere pijplijnen vanaf de opdrachtregel uitvoeren. U kunt Azure CLI-opdrachten gebruiken om alle pijplijnen en definities weer te geven en één release- of build-id als parameter op te geven. Alle opdrachten zijn ontworpen om te werken voor onafhankelijke uitvoeringen van onafhankelijke pijplijnen en ze vereisen unieke id-aanvragen die slechts één unieke waarde toestaan. Zie Gebeurtenissen opgeven die pijplijnen activeren voor meer informatie over pijplijntriggers.

Hoe kan ik een fase in een pijplijnuitvoering overslaan?

U kunt de az rest opdracht gebruiken om de run pipeline Azure DevOps REST API te gebruiken 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 Azure DevOps Services REST API-naslaginformatie voor meer informatie.