Freigeben über

Verwalten Ihrer Pipeline mit der Azure CLI

  • Artikel

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

Mit diesen az pipelines Befehlen können Sie die Pipelines in Ihrer Organisation verwalten:

Diese Befehle erfordern entweder den Namen oder die ID der Pipeline, die Sie verwalten möchten. Sie können die ID einer Pipeline mit dem Befehl az pipelines list abrufen.

Informationen zu den ersten Schritten finden Sie unter Erste Schritte mit der Azure DevOps-CLI.

Führen Sie eine Pipeline aus

Sie können eine vorhandene Pipeline mit dem Befehl az pipelines run in die Warteschlange stellen (ausführen).

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

Parameter

  • branch: Name des Branchs, in dem die Pipeline ausgeführt werden soll, z. B. refs/heads/Standard.
  • Commit-ID: Commit-ID, für die die Pipelineausführung in die Warteschlange gestellt werden soll.
  • folder-path: Ordnerpfad der Pipeline. Der Standardwert ist der Ordner auf Stammebene.
  • ID: Erforderlich, wenn kein Name angegeben wird. ID der pipeline to queue.
  • Name: Erforderlich, wenn die ID nicht angegeben wird, wird jedoch ignoriert, wenn die ID angegeben wird. Name der Pipeline, die in die Warteschlange gestellt werden soll.
  • open: Öffnen Sie die Seite mit den Pipelineergebnissen in Ihrem Webbrowser.
  • org: Azure DevOps Organisation URL. Sie können die Standard-organization mit az devops configure -d organization=ORG_URLkonfigurieren. Erforderlich, wenn nicht als Standard konfiguriert oder mit git configverwendet wird. Beispiel: --org https://dev.azure.com/MyOrganizationName/.
  • project: Name oder ID des Projekts. Sie können das Standardprojekt mit az devops configure -d project=NAME_OR_IDkonfigurieren. Erforderlich, wenn nicht als Standard konfiguriert oder mit git configverwendet wird.
  • variables: Leerzeichentrennte "name=wert"-Paare für die Variablen, die Sie festlegen möchten.

Beispiel

Der folgende Befehl führt die Pipeline mit dem Namen myGithubname.pipelines-java in der Branchpipeline aus und zeigt das Ergebnis im Tabellenformat an.

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

Pipeline aktualisieren

Sie können eine vorhandene Pipeline mit dem Befehl az pipelines update aktualisieren. Informationen zu den ersten Schritten finden Sie unter Erste Schritte mit der Azure DevOps-CLI.

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

Parameter

  • branch: Name des Branchs, in dem die Pipeline ausgeführt werden soll, z. B. refs/heads/main.
  • description: Neue Beschreibung für die Pipeline.
  • ID: Erforderlich, wenn kein Name angegeben wird. ID der zu aktualisierenden Pipeline.
  • Name: Erforderlich, wenn keine ID angegeben wird. Name der zu aktualisierenden Pipeline.
  • new-folder-path: Neuer vollständiger Pfad des Ordners, in den die Pipeline verschoben wird, z. B. user1/production_pipelines.
  • new-name: Neuer aktualisierter Name der Pipeline.
  • org: Azure DevOps Organisation URL. Sie können die Standard-organization mit az devops configure -d organization=ORG_URLkonfigurieren. Erforderlich, wenn nicht als Standard konfiguriert oder mit git configverwendet wird. Beispiel: --org https://dev.azure.com/MyOrganizationName/.
  • project: Name oder ID des Projekts. Sie können das Standardprojekt mit az devops configure -d project=NAME_OR_IDkonfigurieren. Erforderlich, wenn nicht als Standard konfiguriert oder mit git configverwendet wird.
  • queue-id: Warteschlangen-ID des Agentpools, in dem die Pipeline ausgeführt werden muss.
  • yaml-path: Pfad der YAML-Datei der Pipeline im Repository.

Zu den globalen Parametern gehören debug, help, only-show-errors, query, output und verbose.

Tipp

Es gibt auch globale Parameter, die Sie verwenden können, z --output. B. . Der Parameter --output ist für alle Befehle verfügbar. Mit dem Wert table wird die Ausgabe in einem benutzerfreundlichen Format angezeigt. Weitere Informationen finden Sie unter Ausgabeformate für Azure CLI-Befehle.

Beispiel

Der folgende Befehl aktualisiert die Pipeline mit der ID 12 mit einem neuen Namen und einer neuen Beschreibung und zeigt das Ergebnis im Tabellenformat an.

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

Pipeline anzeigen

Sie können die Details einer vorhandenen Pipeline mit dem Befehl az pipelines show anzeigen. Informationen zu den ersten Schritten finden Sie unter Erste Schritte mit der Azure DevOps-CLI.

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

Parameter

  • folder-path: Ordnerpfad der Pipeline. Der Standardwert ist der Ordner auf Stammebene.
  • ID: Erforderlich, wenn kein Name angegeben wird. ID der Pipeline, um Details anzuzeigen.
  • Name: Erforderlich, wenn kein Name angegeben wird, wird jedoch ignoriert, wenn die ID angegeben wird. Name der Pipeline, um Details anzuzeigen.
  • open: Öffnen Sie die Seite mit der Pipelinezusammenfassung in Ihrem Webbrowser.
  • org: Azure DevOps Organisation URL. Sie können die Standard-organization mit az devops configure -d organization=ORG_URLkonfigurieren. Erforderlich, wenn nicht als Standard konfiguriert oder mit git configverwendet wird. Beispiel: --org https://dev.azure.com/MyOrganizationName/.
  • project: Name oder ID des Projekts. Sie können das Standardprojekt mit az devops configure -d project=NAME_OR_IDkonfigurieren. Erforderlich, wenn nicht als Standard konfiguriert oder mit git configverwendet wird.
  • Abfragebeispiele: Empfehlen Sie eine JMESPath-Zeichenfolge für Sie.
  • Abonnement: Name oder ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Beispiel

Der folgende Befehl zeigt die Details der Pipeline mit der ID 12 und gibt das Ergebnis im Tabellenformat zurück.

az pipelines show --id 12 --output table

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

Nächste Schritte

Sie können Ihre Pipeline anpassen oder mehr über das Konfigurieren von Pipelines in der Sprache Ihrer Wahl erfahren:

Häufig gestellte Fragen

Gewusst wie programmgesteuert eine Buildpipeline erstellen?

REST-API-Referenz: Erstellen einer Buildpipeline

Hinweis

Sie können Builds und Buildpipelines auch über die Befehlszeile oder Skripts mithilfe der Azure Pipelines CLI verwalten.

Kann ich mehrere Pipelines in Azure DevOps Services mit einem einzelnen Befehl ausführen?

Derzeit bieten die Azure CLI und Azure-APIs keine Befehle, die mehrere Pipelines über die Befehlszeile ausführen. Sie können Azure CLI-Befehle verwenden, um alle Pipelines und Definitionen aufzulisten und eine einzelne Release- oder Build-ID als Parameter anzugeben. Alle Befehle sind für unabhängige Ausführungen unabhängiger Pipelines konzipiert und erfordern eindeutige ID-Anforderungen, die nur einen eindeutigen Wert zulassen. Informationen zu Pipelinetriggern finden Sie unter Angeben von Ereignissen, die Pipelines auslösen.

Gewusst wie eine Phase in einer Pipelineausführung überspringen?

Mit dem az rest Befehl können Sie die run pipeline Azure DevOps-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 in der REST-API-Referenz zu Azure DevOps Services.