Бөлісу құралы:

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

  • Мақала

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

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

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

Сведения о начале работы см. в статье "Начало работы с Azure DevOps CLI".

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

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

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

Параметры

  • ветвь: имя ветви, в которой выполняется конвейер, должна быть помещена в очередь, например refs/heads/main.
  • commit-id: идентификатор фиксации, в котором выполняется конвейер, должен быть помещен в очередь.
  • путь к папке: путь к папке конвейера. По умолчанию используется папка корневого уровня.
  • идентификатор: обязательный, если имя не указано. Идентификатор конвейера в очередь.
  • имя: обязательный, если идентификатор не указан, но игнорируется, если указан идентификатор . Имя конвейера в очередь.
  • откройте страницу результатов конвейера в веб-браузере.
  • org: URL-адрес организации Azure DevOps. Вы можете настроить организацию по умолчанию с помощью az devops configure -d organization=ORG_URL. Требуется, если не настроено как по умолчанию или выбрано с помощью git config. Пример: --org https://dev.azure.com/MyOrganizationName/.
  • проект: имя или идентификатор проекта. Вы можете настроить проект по умолчанию с помощью az devops configure -d project=NAME_OR_ID. Требуется, если не настроено как по умолчанию или выбрано с помощью git config.
  • переменные: пробелы разделены парами 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]

Параметры

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

Глобальные параметры включают debug, , help, only-show-errorsquery, outputи 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]

Параметры

  • путь к папке: путь к папке конвейера. По умолчанию используется папка корневого уровня.
  • идентификатор: обязательный, если имя не указано. Идентификатор конвейера для отображения сведений.
  • имя: обязательный, если имя не указано, но игнорируется, если указан идентификатор . Имя конвейера для отображения сведений.
  • открыть страницу сводки конвейера в веб-браузере.
  • org: URL-адрес организации Azure DevOps. Вы можете настроить организацию по умолчанию с помощью az devops configure -d organization=ORG_URL. Требуется, если не настроено как по умолчанию или выбрано с помощью git config. Пример: --org https://dev.azure.com/MyOrganizationName/.
  • проект: имя или идентификатор проекта. Вы можете настроить проект по умолчанию с помощью az devops configure -d project=NAME_OR_ID. Требуется, если не настроено как по умолчанию или выбрано с помощью git config.
  • Примеры запросов. Рекомендуется использовать строку JMESPath.
  • подписка: имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью 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 и API Azure не предлагают команды, которые выполняют несколько конвейеров из командной строки. Команды Azure CLI можно использовать для перечисления всех конвейеров и определений и предоставления одного выпуска или идентификатора сборки в качестве параметра. Все команды предназначены для работы для независимых запусков независимых конвейеров, и для них требуются уникальные запросы идентификаторов, разрешающие только одно уникальное значение. Дополнительные сведения об триггерах конвейера см. в разделе "Указание событий, которые активируют конвейеры".

Разделы справки пропустить этап выполнения конвейера?

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