Управление конвейерами с помощью Интерфейса командной строки Azure DevOps
Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2020
В этой статье описывается, как управлять существующими конвейерами в проекте Azure DevOps с помощью следующих команд az pipelines :
- az pipelines list to list pipelines in a project
- az pipelines show to show to show the details of a pipeline
- az pipelines run to run a pipeline
- az pipelines update to update a pipelines
- az pipelines delete to delete a pipeline
Примечание.
Расширение ИНТЕРФЕЙСА командной строки Azure DevOps доступно только для Azure DevOps Services и не поддерживает любую версию Azure DevOps Server.
расширение Azure DevOps CLI.
Группа az-pipelines
команд является частью расширения DevOps в Azure CLI, для которой требуется Azure CLI версии 2.30.0 или более поздней. Расширение Azure DevOps устанавливается автоматически при первом запуске azure pipelines
команды. Дополнительные сведения о начале работы см. в статье "Начало работы с Azure DevOps CLI".
Вы также можете использовать глобальные параметры Azure CLI, такие как debug
, help
, only-show-errors
, output
query
и verbose
в командах Azure DevOps CLI. Значение table
глобального параметра представляет выходные --output
данные в понятном формате. Дополнительные сведения см. в статье Форматы выходных данных для команд Azure CLI.
Вы можете задать организацию Azure DevOps по умолчанию для команд Azure DevOps CLI с помощью или az devops configure --defaults organization=<YourOrganizationURL>
использовать --detect true
параметр для автоматического обнаружения организации. Вы можете настроить проект Azure DevOps по умолчанию с помощью az devops configure -d project=<Project Name or ID>
.
Если вы не обнаруживаете организацию или настраиваете организацию или проект по умолчанию или выбираете организацию и проект, git config
необходимо указать org
project
параметры в каждой команде.
Вывод списка существующих конвейеров
Для run
команд конвейера и delete
команд show
update
конвейера требуется либо name
id
конвейер, которым требуется управлять. При использовании id
name
параметр игнорируется. Чтобы получить список конвейеров проекта, включая идентификаторы, используйте команду az pipelines list . Список результатов можно отфильтровать или отформатировать с помощью параметров.
Например, следующая команда содержит конвейеры проекта с именами, начинающимися с python*
табличного формата.
az pipelines list --name python* --output table
Выходные данные:
ID Path Name Status Default Queue
---- ------ -------------------------- -------- ---------------
17 \ python-sample-vscode-flask disabled Azure Pipelines
24 \ python-sample-get-started enabled Azure Pipelines
Полный справочник по командам см. в списке az pipelines.
Отображение сведений о конвейере
Чтобы просмотреть сведения о существующем конвейере, используйте команду az pipelines show . Например, в следующей команде показаны сведения о конвейере с ID
12
его помощью и откроется страница сводки конвейера в веб-браузере.
az pipelines show --id 12 --open
Полный справочник по команде см. в az pipelines show.
Запуск конвейера
Чтобы выполнить очередь и запустить существующий конвейер, используйте команду az pipelines run . Вы можете задать parameters
и variables
использовать его в выполнении.
Например, следующая команда запускает конвейер с name
myGithubname.pipelines-java
ветвью pipeline
, задает значение переменной var1
100
для выполнения и выходные данные в table
формате.
az pipelines run --name myGithubname.pipelines-java --branch pipeline --variables var1=100 --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
Полный справочник по команде см. в статье az pipelines run.
Обновление конвейера
Чтобы обновить существующий конвейер, используйте команду az pipelines update . Например, следующая команда обновляет конвейер с id
12
новым именем и описанием и выводит результат в формате таблицы.
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
Полный справочник по команде см. в разделе az pipelines update.
Удаление конвейера
Чтобы удалить конвейер, выполните команду az-pipelines-delete . Например, следующая команда удаляет конвейер с идентификатором 12
и не запрашивает подтверждение. Если параметр не включен --yes
, командная строка для подтверждения по умолчанию.
az pipelines delete --id 12 --yes
Полный справочник по команде см. в статье az pipelines delete.
Программное создание и настройка конвейеров
Сведения об использовании Azure DevOps CLI для создания конвейера YAML см. в статье az pipelines create. Чтобы запустить команды Azure CLI в конвейерах YAML, ознакомьтесь с интерфейсом командной строки Azure DevOps в YAML Azure Pipelines.
Конвейеры YAML можно создавать, настраивать, тестировать и развертывать приложения на выбранном языке. Дополнительные сведения см. в следующих статьях:
- Сборка, тестирование и развертывание приложений .NET Core
- Сборка и тестирование проектов Go
- Создание приложений Java
- Создание и публикация пакета Node.js
- Создание и публикация приложения Python
- Создание образа контейнера для развертывания приложений
- Настройка конвейера
Azure DevOps Services REST API
Вы можете создавать пользовательские приложения или службы, которые интегрируются с Azure DevOps с помощью REST API для прямых вызовов HTTP. Дополнительные сведения см. в справочнике по REST API Azure DevOps Services. Вы также можете использовать клиентские библиотеки для этих API.
Пропуск этапа выполнения конвейера
Команду az rest можно использовать с помощью REST API запуска конвейера, чтобы пропустить этап выполнения конвейера с помощью stagesToSkip
параметра.
Например:
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
Дополнительные сведения см. в статье "Использование REST API Azure" с Помощью Azure CLI.