Поделиться через

Управление конвейерами с помощью Интерфейса командной строки Azure DevOps

  • Статья

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

В этой статье описывается, как управлять существующими конвейерами в проекте Azure DevOps с помощью следующих команд az pipelines :

Примечание.

Расширение ИНТЕРФЕЙСА командной строки 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, queryoutputи 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, show, update и delete конвейера требуется указать либо 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 list.

Отображение сведений о конвейере

Чтобы просмотреть сведения о существующем конвейере, используйте команду 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 можно создавать, настраивать, тестировать и развертывать приложения на выбранном языке. Дополнительные сведения см. в следующих статьях:

Azure DevOps Services REST API

Вы можете создавать пользовательские приложения или службы, которые интегрируются с Azure DevOps с помощью REST API для прямых вызовов HTTP. Для получения дополнительной информации см. справочник по REST API Azure DevOps Services. Вы также можете использовать клиентские библиотеки для этих API.

Пропустить этап в запуске конвейера

Вы можете использовать команду az rest с помощью REST API Run Pipeline, чтобы пропустить этап в выполнении конвейера, используя параметр 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.

Связанный контент