Zarządzanie potokami za pomocą interfejsu wiersza polecenia usługi Azure DevOps
Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2020
W tym artykule opisano sposób zarządzania istniejącymi potokami w projekcie usługi Azure DevOps przy użyciu następujących poleceń az pipelines :
- az pipelines list to list pipelines in a project (az pipelines list to list pipelines in a project)
- az pipelines show , aby wyświetlić szczegóły potoku
- az pipelines run to run a pipelines (az pipelines run to run a pipelines to run a pipelines to run
- az pipelines update w celu zaktualizowania potoku
- az pipelines delete w celu usunięcia potoku
Uwaga
Rozszerzenie interfejsu wiersza polecenia usługi Azure DevOps jest dostępne tylko dla usług Azure DevOps Services i nie obsługuje żadnej wersji usługi Azure DevOps Server.
Azure DevOps CLI extension (Rozszerzenie interfejsu wiersza polecenia usługi Azure DevOps)
Grupa az-pipelines
poleceń jest częścią rozszerzenia DevOps interfejsu wiersza polecenia platformy Azure, które wymaga interfejsu wiersza polecenia platformy Azure w wersji 2.30.0 lub nowszej. Rozszerzenie Usługi Azure DevOps instaluje automatycznie przy pierwszym uruchomieniu azure pipelines
polecenia. Aby uzyskać więcej informacji na temat rozpoczynania pracy, zobacz Wprowadzenie do interfejsu wiersza polecenia usługi Azure DevOps.
Możesz również użyć globalnych parametrów interfejsu wiersza polecenia platformy Azure, takich jak debug
, help
, only-show-errors
, query
output
, i verbose
, w poleceniach interfejsu wiersza polecenia usługi Azure DevOps. Wartość table
parametru globalnego --output
przedstawia dane wyjściowe w przyjaznym formacie. Aby uzyskać więcej informacji, zobacz Formaty danych wyjściowych dla poleceń interfejsu wiersza polecenia platformy Azure.
Możesz ustawić domyślną organizację usługi Azure DevOps dla poleceń interfejsu wiersza polecenia usługi Azure DevOps przy użyciu polecenia az devops configure --defaults organization=<YourOrganizationURL>
, lub użyć parametru --detect true
, aby automatycznie wykryć organizację. Domyślny projekt usługi Azure DevOps można skonfigurować przy użyciu polecenia az devops configure -d project=<Project Name or ID>
.
Jeśli nie wykryjesz organizacji lub skonfigurujesz domyślnej organizacji lub projektu albo wybierz organizację i projekt za pomocą git config
polecenia , musisz określić org
parametry i w project
każdym poleceniu.
Wyświetlanie listy istniejących potoków
Polecenia run
, show
, update
i delete
potoku wymagają name
potoku lub id
, którym chcesz zarządzać. W przypadku użycia parametru id
name
parametr jest ignorowany. Aby uzyskać listę potoków projektu, w tym ich identyfikatory, użyj polecenia az pipelines list . Listę wyników można filtrować lub formatować przy użyciu parametrów.
Na przykład następujące polecenie wyświetla listę potoków projektu, które mają nazwy rozpoczynające się od python*
, w formacie tabeli.
az pipelines list --name python* --output table
Wyjście:
ID Path Name Status Default Queue
---- ------ -------------------------- -------- ---------------
17 \ python-sample-vscode-flask disabled Azure Pipelines
24 \ python-sample-get-started enabled Azure Pipelines
Aby uzyskać pełną dokumentację poleceń, zobacz az pipelines list.
Pokaż szczegóły potoku
Aby wyświetlić szczegóły istniejącego potoku, użyj polecenia az pipelines show . Na przykład następujące polecenie wyświetla szczegóły potoku z wartością ID
12
, a następnie otwiera stronę podsumowania potoku w przeglądarce internetowej.
az pipelines show --id 12 --open
Aby uzyskać pełną dokumentację poleceń, zobacz az pipelines show.
Uruchamianie potoku
Aby kolejkować i uruchamiać istniejący potok, użyj polecenia az pipelines run . Możesz ustawić parameters
polecenie i variables
użyć w przebiegu.
Na przykład następujące polecenie uruchamia potok z gałęzią name
myGithubname.pipelines-java
w pipeline
gałęzi, ustawia wartość zmiennej var1
na 100
dla przebiegu, a dane wyjściowe są w table
formacie .
az pipelines run --name myGithubname.pipelines-java --branch pipeline --variables var1=100 --output table
Wyjście:
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
Aby uzyskać pełną dokumentację poleceń, zobacz az pipelines run.
Aktualizowanie potoku
Aby zaktualizować istniejący potok, użyj polecenia az pipelines update . Na przykład następujące polecenie aktualizuje potok przy id
12
użyciu nowej nazwy i opisu oraz zwraca wynik w formacie tabeli.
az pipelines update --id 12 --description "rename pipeline" --new-name updatedname.pipelines-java --output table
Wyjście:
ID Name Status Default Queue
---- -------------------------- -------- ------------------
12 updatedname.pipelines-java enabled Hosted Ubuntu 1604
Aby uzyskać pełną dokumentację poleceń, zobacz az pipelines update.
Usuwanie potoku
Aby usunąć potok, uruchom polecenie az-pipelines-delete . Na przykład następujące polecenie usuwa potok o identyfikatorze 12
i nie wyświetla monitu o potwierdzenie. Jeśli nie dołączysz parametru --yes
, domyślnie monituje o potwierdzenie.
az pipelines delete --id 12 --yes
Aby uzyskać pełną dokumentację poleceń, zobacz az pipelines delete.
Programowe tworzenie i konfigurowanie potoków
Aby utworzyć potok YAML za pomocą interfejsu wiersza polecenia usługi Azure DevOps, zobacz az pipelines create. Aby uruchomić polecenia interfejsu wiersza polecenia platformy Azure w potokach YAML, zobacz Interfejs wiersza polecenia usługi Azure DevOps w usłudze Azure Pipelines YAML.
Potoki YAML można tworzyć, konfigurować, testować i wdrażać aplikacje w wybranym języku. Aby uzyskać więcej informacji, zobacz następujące artykuły:
- Tworzenie, testowanie i wdrażanie aplikacji platformy .NET Core
- Kompilowanie i testowanie projektów języka Go
- Tworzenie aplikacji Java
- Kompilowanie i publikowanie pakietu Node.js
- Kompilowanie i publikowanie aplikacji w języku Python
- Tworzenie obrazu kontenera do wdrażania aplikacji
- Dostosowywanie potoku
Azure DevOps Services REST API
Możesz tworzyć niestandardowe aplikacje lub usługi integrujące się z usługą Azure DevOps przy użyciu interfejsów API REST, aby wykonywać bezpośrednie wywołania HTTP. Aby uzyskać więcej informacji, zobacz Dokumentację interfejsu API REST usługi Azure DevOps Services. Możesz również użyć bibliotek klienckich dla tych interfejsów API.
Pomijanie etapu w przebiegu potoku
Możesz użyć polecenia az rest z interfejsem API REST potoku uruchamiania, 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 Używanie interfejsu API REST platformy Azure z interfejsem wiersza polecenia platformy Azure.