Управление конвейером с помощью Azure CLI

  • Мақала

Azure DevOps Services | Azure DevOps Server 2022 г. | Azure DevOps Server 2020 г.

Вы можете управлять конвейерами в организации с помощью следующих az pipelines команд:

  • az pipelines run: запуск существующего конвейера
  • az pipelines update: обновление существующего конвейера
  • az pipelines show: отображение сведений о существующем конвейере

Для этих команд требуется имя или идентификатор конвейера, которым вы хотите управлять. Идентификатор конвейера можно получить с помощью команды az pipelines list .

Чтобы приступить к работе, см. статью Начало работы с Azure DevOps CLI.

Запуск конвейера

Вы можете поместить в очередь (запустить) существующий конвейер с помощью команды az pipelines run .

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

Параметры

  • branch: имя ветви, в которой должен быть поставлен конвейер в очередь, например refs/heads/main.
  • commit-id: commit-id, в котором должен быть поставлен конвейер в очередь.
  • folder-path: путь к папке конвейера. По умолчанию используется папка корневого уровня.
  • id: требуется, если имя не указано. Идентификатор конвейера в очередь.
  • name: требуется, если идентификатор не указан, но игнорируется, если указан идентификатор . Имя конвейера в очередь.
  • open: откройте страницу результатов конвейера в веб-браузере.
  • org: URL-адрес организации Azure DevOps. Вы можете настроить организацию по умолчанию с помощью az devops configure -d organization=ORG_URL. Требуется, если не настроено по умолчанию или выбрано с помощью git config. Например, --org https://dev.azure.com/MyOrganizationName/.
  • project: имя или идентификатор проекта. Проект по умолчанию можно настроить с помощью az devops configure -d project=NAME_OR_ID. Требуется, если не настроено по умолчанию или выбрано с помощью git config.
  • variables: разделенные парами "name=value" для переменных, которые вы хотите задать.

Пример

Следующая команда запускает конвейер с именем myGithubname.pipelines-java в конвейере ветви и отображает результат в формате таблицы.

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

Обновление конвейера

Вы можете обновить существующий конвейер с помощью команды az pipelines update . Чтобы приступить к работе, см. статью Начало работы с Azure DevOps CLI.

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

Параметры

  • branch: имя ветви, в которой должен быть настроен конвейер, например refs/heads/main.
  • description: новое описание конвейера.
  • id: требуется, если имя не указано. Идентификатор обновляемого конвейера.
  • name: требуется, если идентификатор не указан. Имя обновляемого конвейера.
  • new-folder-path: новый полный путь к папке, в которую перемещается конвейер, например user1/production_pipelines.
  • new-name: новое обновленное имя конвейера.
  • org: URL-адрес организации Azure DevOps. Вы можете настроить организацию по умолчанию с помощью az devops configure -d organization=ORG_URL. Требуется, если не настроено по умолчанию или выбрано с помощью git config. Например, --org https://dev.azure.com/MyOrganizationName/.
  • project: имя или идентификатор проекта. Проект по умолчанию можно настроить с помощью az devops configure -d project=NAME_OR_ID. Требуется, если не настроено по умолчанию или выбрано с помощью git config.
  • queue-id: идентификатор очереди пула агентов, в котором должен выполняться конвейер.
  • yaml-path: путь к YAML-файлу конвейера в репозитории.

Глобальные параметры включают debug, help, only-show-errors, outputquery, и verbose.

Совет

Существуют также глобальные параметры, которые можно использовать, --outputнапример . Параметр --output доступен для всех команд. Значение table позволяет получить выходные данные в удобном формате. Дополнительные сведения см. в статье Форматы выходных данных для команд Azure CLI.

Пример

Следующая команда обновляет конвейер с идентификатором 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 show . Чтобы приступить к работе, см. статью Начало работы с Azure DevOps CLI.

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

Параметры

  • folder-path: путь к папке конвейера. По умолчанию используется папка корневого уровня.
  • id: требуется, если имя не указано. Идентификатор конвейера для отображения сведений.
  • name: является обязательным, если имя не указано, но игнорируется, если указан идентификатор . Имя конвейера для отображения сведений.
  • open: откройте страницу сводки по конвейеру в веб-браузере.
  • org: URL-адрес организации Azure DevOps. Вы можете настроить организацию по умолчанию с помощью az devops configure -d organization=ORG_URL. Требуется, если не настроено по умолчанию или выбрано с помощью git config. Например, --org https://dev.azure.com/MyOrganizationName/.
  • project: имя или идентификатор проекта. Проект по умолчанию можно настроить с помощью az devops configure -d project=NAME_OR_ID. Требуется, если не настроено по умолчанию или выбрано с помощью git config.
  • примеры запросов. Рекомендуем использовать строку JMESPath.
  • subscription: имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Пример

Следующая команда показывает сведения о конвейере с идентификатором 12 и возвращает результат в формате таблицы.

az pipelines show --id 12 --output table

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

Дальнейшие действия

Вы можете настроить конвейер или узнать больше о настройке конвейеров на выбранном языке:

Вопросы и ответы

Разделы справки создать конвейер сборки программным способом?

Справочник по REST API: создание конвейера сборки

Примечание

Вы также можете управлять сборками и конвейерами сборки из командной строки или скриптов с помощью Интерфейса командной строки Azure Pipelines.

Можно ли запустить несколько конвейеров в Azure DevOps Services с помощью одной команды?

В настоящее время Azure CLI и API Azure не предлагают команды, которые запускают несколько конвейеров из командной строки. Команды Azure CLI можно использовать для вывода списка всех конвейеров и определений и предоставления одного выпуска или идентификатора сборки в качестве параметра. Все команды предназначены для независимых запусков независимых конвейеров и требуют запросов уникальных идентификаторов, допускающих только одно уникальное значение. Дополнительные сведения о триггерах конвейера см. в разделе Указание событий, запускающих конвейеры.