Runs - Run Pipeline

Ссылка

Service:: Pipelines

API Version:: 7.1-preview.1

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

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1-preview.1

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=7.1-preview.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-preview.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

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token 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

Scopes

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

Имя

Описание

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

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

Container

Имя	Тип	Описание
environment	object
image	string
mapDockerSocket	boolean
options	string
ports	string[]
volumes	string[]

ContainerResource

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

ContainerResourceParameters

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

PackageResourceParameters

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

PipelineReference

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

Имя	Тип	Описание
folder	string	Папка конвейера
id	integer	Идентификатор конвейера
name	string	Имя конвейера
revision	integer	Номер редакции
url	string

PipelineResource

Имя	Тип	Описание
pipeline	PipelineReference	Ссылка на конвейер.
version	string

PipelineResourceParameters

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

ReferenceLinks

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

Имя	Тип	Описание
links	object	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

Repository

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

RepositoryResource

Имя	Тип	Описание
refName	string
repository	Repository
version	string

RepositoryResourceParameters

Имя	Тип	Описание
refName	string
token	string	Это маркер безопасности, используемый при подключении к репозиторию.
tokenType	string	Необязательный элемент. Это тип заданного маркера. Если значение не указано, предполагается тип Bearer. Примечание. Используйте "Базовый" для маркера PAT.
version	string

RepositoryType

Имя	Тип	Описание
azureReposGit	string
azureReposGitHyphenated	string
gitHub	string
gitHubEnterprise	string
unknown	string

Run

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
createdDate	string
finalYaml	string
finishedDate	string
id	integer
name	string
pipeline	PipelineReference	Ссылка на конвейер.
resources	RunResources
result	RunResult
state	RunState
templateParameters	object
url	string
variables	<string, Variable>

RunPipelineParameters

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

Имя	Тип	Описание
previewRun	boolean	Если задано значение true, не создавайте новый запуск. Вместо этого верните окончательный документ YAML после анализа шаблонов.
resources	RunResourcesParameters	Ресурсы, необходимые для выполнения.
stagesToSkip	string[]
templateParameters	object
variables	<string, Variable>
yamlOverride	string	Если вы используете параметр запуска предварительной версии, при необходимости можно указать другой YAML. Это позволяет предварительно просмотреть окончательный документ YAML без фиксации измененного файла.

RunResources

Имя	Тип	Описание
containers	<string, ContainerResource>
pipelines	<string, PipelineResource>
repositories	<string, RepositoryResource>

RunResourcesParameters

Имя	Тип	Описание
builds	<string, BuildResourceParameters>
containers	<string, ContainerResourceParameters>
packages	<string, PackageResourceParameters>
pipelines	<string, PipelineResourceParameters>
repositories	<string, RepositoryResourceParameters>

RunResult

Имя	Тип	Описание
canceled	string
failed	string
succeeded	string
unknown	string

RunState

Имя	Тип	Описание
canceling	string
completed	string
inProgress	string
unknown	string

Variable

Имя	Тип	Описание
isSecret	boolean
value	string

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