Udostępnij za pośrednictwem

Zarządzanie potokiem za pomocą interfejsu wiersza polecenia platformy Azure

  • Artykuł

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

Potoki w organizacji można zarządzać przy użyciu następujących az pipelines poleceń:

Te polecenia wymagają nazwy lub identyfikatora potoku, którym chcesz zarządzać. Identyfikator potoku można uzyskać przy użyciu polecenia az pipelines list .

Aby rozpocząć, zobacz Wprowadzenie do interfejsu wiersza polecenia usługi Azure DevOps.

Uruchamianie potoku

Istniejący potok można kolejkować (uruchomić) za pomocą polecenia az pipelines run .

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

Parametry

  • branch: nazwa gałęzi, w której ma być kolejkowany przebieg potoku, na przykład refs/heads/main.
  • commit-id: identyfikator zatwierdzenia, w którym ma zostać w kolejce przebieg potoku.
  • ścieżka-folderu: ścieżka folderu potoku. Wartość domyślna to folder poziomu głównego.
  • id: Wymagane, jeśli nazwa nie jest podana. Identyfikator potoku do kolejki.
  • name: wymagane, jeśli nie podano identyfikatora , ale ignorowane, jeśli podano identyfikator . Nazwa potoku do kolejki.
  • otwórz: otwórz stronę wyników potoku w przeglądarce internetowej.
  • org: Adres URL organizacji usługi Azure DevOps. Domyślną organizację można skonfigurować przy użyciu polecenia az devops configure -d organization=ORG_URL. Wymagane, jeśli wartość domyślna nie jest skonfigurowana lub została wybrana przy użyciu polecenia git config. Przykład: --org https://dev.azure.com/MyOrganizationName/.
  • projekt: nazwa lub identyfikator projektu. Projekt domyślny można skonfigurować przy użyciu polecenia az devops configure -d project=NAME_OR_ID. Wymagane, jeśli wartość domyślna nie jest skonfigurowana lub została wybrana przy użyciu polecenia git config.
  • zmienne: rozdzielone spacją pary "name=value" dla zmiennych, które chcesz ustawić.

Przykład

Następujące polecenie uruchamia potok o nazwie myGithubname.pipelines-java w potoku gałęzi i wyświetla wynik w formacie tabeli.

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

Aktualizowanie potoku

Istniejący potok można zaktualizować za pomocą polecenia az pipelines update . Aby rozpocząć, zobacz Wprowadzenie do interfejsu wiersza polecenia usługi Azure DevOps.

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

Parametry

  • branch: nazwa gałęzi, w której ma zostać skonfigurowany przebieg potoku, na przykład refs/heads/main.
  • description: Nowy opis potoku.
  • id: Wymagane, jeśli nazwa nie jest podana. Identyfikator potoku do zaktualizowania.
  • name: wymagane, jeśli nie podano identyfikatora . Nazwa potoku do zaktualizowania.
  • new-folder-path: Nowa pełna ścieżka folderu, do którego jest przenoszony potok, na przykład user1/production_pipelines.
  • nowa nazwa: nowa zaktualizowana nazwa potoku.
  • org: Adres URL organizacji usługi Azure DevOps. Domyślną organizację można skonfigurować przy użyciu polecenia az devops configure -d organization=ORG_URL. Wymagane, jeśli wartość domyślna nie jest skonfigurowana lub została wybrana przy użyciu polecenia git config. Przykład: --org https://dev.azure.com/MyOrganizationName/.
  • projekt: nazwa lub identyfikator projektu. Projekt domyślny można skonfigurować przy użyciu polecenia az devops configure -d project=NAME_OR_ID. Wymagane, jeśli wartość domyślna nie jest skonfigurowana lub została wybrana przy użyciu polecenia git config.
  • queue-id: identyfikator kolejki puli agentów, w której należy uruchomić potok.
  • yaml-path: ścieżka pliku yaml potoku w repozytorium.

Parametry globalne obejmują debug, , help, queryonly-show-errors, output, i verbose.

Napiwek

Istnieją również parametry globalne, których można użyć, takich jak --output. Parametr --output jest dostępny dla wszystkich poleceń. Wartość tabeli przedstawia dane wyjściowe w przyjaznym formacie. Aby uzyskać więcej informacji, zobacz Formaty danych wyjściowych dla poleceń interfejsu wiersza polecenia platformy Azure.

Przykład

Następujące polecenie aktualizuje potok o identyfikatorze 12 z nową nazwą i opisem oraz pokazuje wynik w formacie tabeli.

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

Pokaż potok

Szczegóły istniejącego potoku można wyświetlić za pomocą polecenia az pipelines show . Aby rozpocząć, zobacz Wprowadzenie do interfejsu wiersza polecenia usługi Azure DevOps.

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

Parametry

  • ścieżka-folderu: ścieżka folderu potoku. Wartość domyślna to folder poziomu głównego.
  • id: Wymagane, jeśli nazwa nie jest podana. Identyfikator potoku, aby wyświetlić szczegóły.
  • name: wymagane, jeśli nazwa nie jest podana, ale ignorowana, jeśli podano identyfikator . Nazwa potoku, aby wyświetlić szczegóły.
  • otwórz: otwórz stronę podsumowania potoku w przeglądarce internetowej.
  • org: Adres URL organizacji usługi Azure DevOps. Domyślną organizację można skonfigurować przy użyciu polecenia az devops configure -d organization=ORG_URL. Wymagane, jeśli wartość domyślna nie jest skonfigurowana lub została wybrana przy użyciu polecenia git config. Przykład: --org https://dev.azure.com/MyOrganizationName/.
  • projekt: nazwa lub identyfikator projektu. Projekt domyślny można skonfigurować przy użyciu polecenia az devops configure -d project=NAME_OR_ID. Wymagane, jeśli wartość domyślna nie jest skonfigurowana lub została wybrana przy użyciu polecenia git config.
  • przykłady zapytań: zalecamy ciąg JMESPath.
  • subskrypcja: nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

Przykład

Poniższe polecenie przedstawia szczegóły potoku o identyfikatorze 12 i zwraca wynik w formacie tabeli.

az pipelines show --id 12 --output table

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

Następne kroki

Możesz dostosować potok lub dowiedzieć się więcej na temat konfigurowania potoków w wybranym języku:

Często zadawane pytania

Jak mogę programowo utworzyć potok kompilacji?

Dokumentacja interfejsu API REST: tworzenie potoku kompilacji

Uwaga

Możesz również zarządzać kompilacjami i potokami kompilacji z poziomu wiersza polecenia lub skryptów przy użyciu interfejsu wiersza polecenia usługi Azure Pipelines.

Czy mogę uruchomić wiele potoków w usłudze Azure DevOps Services przy użyciu jednego polecenia?

Obecnie interfejs wiersza polecenia platformy Azure i interfejsy API platformy Azure nie oferują poleceń, które uruchamiają wiele potoków z wiersza polecenia. Polecenia interfejsu wiersza polecenia platformy Azure umożliwiają wyświetlenie listy wszystkich potoków i definicji oraz podanie pojedynczego wydania lub identyfikatora kompilacji jako parametru. Wszystkie polecenia są przeznaczone do pracy z niezależnymi przebiegami niezależnych potoków i wymagają unikatowych żądań identyfikatorów, które zezwalają tylko na jedną, unikatową wartość. Aby dowiedzieć się więcej o wyzwalaczach potoku, zobacz Określanie zdarzeń wyzwalających potoki.

Jak mogę pominąć etap w przebiegu potoku?

Możesz użyć az rest polecenia , aby użyć interfejsu run pipeline API REST usługi Azure DevOps, aby pominąć etap w przebiegu potoku przy użyciu parametru stagesToSkip .

Na przykład:

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

Aby uzyskać więcej informacji, zobacz Dokumentacja interfejsu API REST usługi Azure DevOps Services.