Freigeben über

Verwalten von Pipelines mit der Azure DevOps CLI

  • Artikel

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

In diesem Artikel wird beschrieben, wie Sie vorhandene Pipelines in Ihrem Azure DevOps-Projekt mithilfe der folgenden Az-Pipelines-Befehle verwalten können:

Hinweis

Die Azure DevOps CLI-Erweiterung ist nur für Azure DevOps Services verfügbar und unterstützt keine Version von Azure DevOps Server.

Azure DevOps-CLI-Erweiterung

Die az-pipelines Befehlsgruppe ist Teil der DevOps-Erweiterung auf die Azure CLI, die Azure CLI Version 2.30.0 oder höher erfordert. Die Azure DevOps-Erweiterung wird automatisch installiert, wenn Sie einen azure pipelines Befehl zum ersten Mal ausführen. Weitere Informationen zu den ersten Schritten finden Sie unter "Erste Schritte mit Azure DevOps CLI".

Sie können auch globale Azure CLI-Parameter wie debug, , , help, only-show-errors, queryoutputund , in verboseIhren Azure DevOps CLI-Befehlen verwenden. Der table Wert für den globalen Parameter stellt die --output Ausgabe in einem anzeigefreundlichen Format dar. Weitere Informationen finden Sie unter Ausgabeformate für Azure CLI-Befehle.

Sie können die Standardmäßige Azure DevOps-Organisation für Azure DevOps CLI-Befehle mithilfe az devops configure --defaults organization=<YourOrganizationURL>des Parameters festlegen oder den --detect true Parameter verwenden, um die Organisation automatisch zu erkennen. Sie können das Standardmäßige Azure DevOps-Projekt mithilfe von az devops configure -d project=<Project Name or ID>.

Wenn Sie die Organisation nicht erkennen oder eine Standardorganisation oder ein Standardprojekt konfigurieren oder die Organisation und das Projekt überholengit config, müssen Sie die und project die org Parameter in den einzelnen Befehlen angeben.

Auflisten vorhandener Pipelines

Die runBefehle , show, , updateund delete Pipeline erfordern entweder die name id Oder der Pipeline, die Sie verwalten möchten. Bei Verwendung idwird der name Parameter ignoriert. Verwenden Sie zum Abrufen einer Liste von Projektpipelinen, einschließlich ihrer IDs, den Befehl "az pipelines list ". Sie können die Ergebnisliste mithilfe von Parametern filtern oder formatieren.

Der folgende Befehl listet z. B. die Projektpipelinen auf, die mit Namen beginnen python*, im Tabellenformat.

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

Ausgabe:

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

Die vollständige Befehlsreferenz finden Sie in der Az-Pipelines-Liste.

Anzeigen von Details für eine Pipeline

Um die Details einer vorhandenen Pipeline anzuzeigen, verwenden Sie den Befehl "az pipelines show ". Der folgende Befehl zeigt z. B. die Details der Pipeline mit dem ID von 12und öffnet die Pipelinezusammenfassungsseite in Ihrem Webbrowser.

az pipelines show --id 12 --open

Die vollständige Befehlsreferenz finden Sie unter az pipelines show.

Führen Sie eine Pipeline aus

Um eine vorhandene Pipeline in die Warteschlange zu stellen und auszuführen, verwenden Sie den Befehl "az pipelines run ". Sie können festlegen parameters und variables in der Ausführung verwenden.

Beispielsweise führt der folgende Befehl die Pipeline mit name myGithubname.pipelines-java in der pipeline Verzweigung aus, legt den Wert der Variablen var1 100 für die Ausführung fest und gibt Ergebnisse im table Format aus.

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

Ausgabe:

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

Die vollständige Befehlsreferenz finden Sie unter "az pipelines run".

Pipeline aktualisieren

Um eine vorhandene Pipeline zu aktualisieren, verwenden Sie den Befehl "az pipelines update ". Beispielsweise aktualisiert der folgende Befehl die Pipeline mit einem id 12 neuen Namen und einer neuen Beschreibung und gibt das Ergebnis im Tabellenformat aus.

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

Ausgabe:

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

Die vollständige Befehlsreferenz finden Sie unter az pipelines update.

Löschen einer Pipeline

Führen Sie den Befehl "az-pipelines-delete " aus, um eine Pipeline zu löschen. Der folgende Befehl löscht z. B. die Pipeline mit der ID von 12, und fordert keine Bestätigung auf. Wenn Sie den --yes Parameter nicht einschließen, werden die Eingabeaufforderungen standardmäßig zur Bestätigung aufgefordert.

az pipelines delete --id 12 --yes

Die vollständige Befehlsreferenz finden Sie unter "az pipelines delete".

Programmgesteuertes Erstellen und Konfigurieren von Pipelines

Informationen zur Verwendung der Azure DevOps CLI zum Erstellen einer YAML-Pipeline finden Sie unter az pipelines create. Informationen zum Ausführen von Azure CLI-Befehlen in YAML-Pipelines finden Sie unter Azure DevOps CLI in Azure Pipelines YAML.

Sie können YAML-Pipelines erstellen, um Apps in der von Ihnen gewählten Sprache zu erstellen, zu konfigurieren, zu testen und bereitzustellen. Weitere Informationen finden Sie in den folgenden Artikeln:

REST-API für Azure DevOps Services

Sie können benutzerdefinierte Anwendungen oder Dienste erstellen, die in Azure DevOps integriert sind, indem Sie die REST-APIs verwenden, um direkte HTTP-Aufrufe zu tätigen. Weitere Informationen finden Sie in der REST-API-Referenz zu Azure DevOps Services. Sie können auch die Clientbibliotheken für diese APIs verwenden.

Überspringen einer Phase in einer Pipelineausführung

Sie können den Az-Rest-Befehl mit der Run Pipeline REST-API verwenden, um eine Phase in einer Pipelineausführung mit dem stagesToSkip Parameter zu überspringen.

Zum Beispiel:

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

Weitere Informationen finden Sie unter Verwenden der Azure REST-API mit Azure CLI.

Zugehöriger Inhalt