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

Runs - Run Pipeline

  • Ссылка
Служба:
Pipelines
Версия API:
7.1

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

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1
С использованием необязательных параметров: 
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=7.1

Параметры URI

Имя В Обязательно Тип Описание
organization
 path True

string

Имя организации Azure DevOps.
pipelineId
 path True

integer (int32)

Идентификатор конвейера.
project
 path True

string

Идентификатор проекта или имя проекта
api-version
 query True

string

Используемая версия API. Для использования этой версии API необходимо задать значение "7.1".
pipelineVersion
 query

integer (int32)

Версия конвейера.

Текст запроса

Имя Тип Описание
previewRun

boolean

Если значение true, не создайте новый запуск. Вместо этого верните окончательный документ YAML после анализа шаблонов.
resources

RunResourcesParameters

Необходимые ресурсы.
stagesToSkip

string[]

templateParameters

object

variables

<string,  Variable>

yamlOverride

string

Если вы используете параметр предварительного просмотра, вы можете при необходимости указать разные YAML. Это позволяет предварительно просмотреть окончательный документ YAML без фиксации измененного файла.

Ответы

Имя Тип Описание
200 OK

Run

успешная операция

Безопасность

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL-адрес токена: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Области

Имя Описание
vso.build_execute Предоставляет возможность доступа к артефактам сборки, включая результаты сборки, определения и запросы, а также возможность очереди сборки, обновления свойств сборки и возможность получать уведомления о событиях сборки с помощью перехватчиков служб.

Определения

Имя Описание
BuildResourceParameters
Container
ContainerResource
ContainerResourceParameters
PackageResourceParameters
PipelineReference

Ссылка на конвейер.
PipelineResource
PipelineResourceParameters
ReferenceLinks

Класс, представляющий коллекцию ссылок REST.
Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters

Параметры, влияющие на запуски конвейера.
RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Object
Имя Тип Описание
version

string

Container

Object
Имя Тип Описание
environment

object

image

string

mapDockerSocket

boolean

options

string

ports

string[]

volumes

string[]

ContainerResource

Object
Имя Тип Описание
container

Container

ContainerResourceParameters

Object
Имя Тип Описание
version

string

PackageResourceParameters

Object
Имя Тип Описание
version

string

PipelineReference

Object

Ссылка на конвейер.

Имя Тип Описание
folder

string

Папка конвейера
id

integer (int32)

Идентификатор конвейера
name

string

Имя конвейера
revision

integer (int32)

Номер редакции
url

string

PipelineResource

Object
Имя Тип Описание
pipeline

PipelineReference

Ссылка на конвейер.
version

string

PipelineResourceParameters

Object
Имя Тип Описание
version

string

Object

Класс, представляющий коллекцию ссылок REST.

Имя Тип Описание
links

object

Режим чтения ссылок. Так как ссылки ссылки доступны только для чтения, мы хотим предоставлять их только как доступные только для чтения.

Repository

Object
Имя Тип Описание
type

RepositoryType

RepositoryResource

Object
Имя Тип Описание
refName

string

repository

Repository

version

string

RepositoryResourceParameters

Object
Имя Тип Описание
refName

string

token

string

Это маркер безопасности, используемый при подключении к репозиторию.
tokenType

string

Необязательный. Это тип заданного маркера. Если это не указано, предполагается тип носителя. Примечание. Используйте "Basic" для токена PAT.
version

string

RepositoryType

Перечисление
Значение Описание
azureReposGit
azureReposGitHyphenated
gitHub
gitHubEnterprise
unknown

Run

Object
Имя Тип Описание
_links

ReferenceLinks

Класс, представляющий коллекцию ссылок REST.
createdDate

string (date-time)

finalYaml

string

finishedDate

string (date-time)

id

integer (int32)

name

string

pipeline

PipelineReference

Ссылка на конвейер.
resources

RunResources

result

RunResult

state

RunState

templateParameters

object

url

string

variables

<string,  Variable>

RunPipelineParameters

Object

Параметры, влияющие на запуски конвейера.

Имя Тип Описание
previewRun

boolean

Если значение true, не создайте новый запуск. Вместо этого верните окончательный документ YAML после анализа шаблонов.
resources

RunResourcesParameters

Необходимые ресурсы.
stagesToSkip

string[]

templateParameters

object

variables

<string,  Variable>

yamlOverride

string

Если вы используете параметр предварительного просмотра, вы можете при необходимости указать разные YAML. Это позволяет предварительно просмотреть окончательный документ YAML без фиксации измененного файла.

RunResources

Object
Имя Тип Описание
containers

<string,  ContainerResource>

pipelines

<string,  PipelineResource>

repositories

<string,  RepositoryResource>

RunResourcesParameters

Object
Имя Тип Описание
builds

<string,  BuildResourceParameters>

containers

<string,  ContainerResourceParameters>

packages

<string,  PackageResourceParameters>

pipelines

<string,  PipelineResourceParameters>

repositories

<string,  RepositoryResourceParameters>

RunResult

Перечисление
Значение Описание
canceled
failed
succeeded
unknown

RunState

Перечисление
Значение Описание
canceling
completed
inProgress
unknown

Variable

Object
Имя Тип Описание
isSecret

boolean

value

string