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)	管道 ID。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。
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
流向: 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)	管道 ID
name	string	管道名称
revision	integer (int32)	修订号
url	string

PipelineResource

Object

名称	类型	说明
pipeline	PipelineReference	对管道的引用。
version	string

PipelineResourceParameters

Object

名称	类型	说明
version	string

ReferenceLinks

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。

Repository

Object

名称	类型	说明
type	RepositoryType

RepositoryResource

Object

名称	类型	说明
refName	string
repository	Repository
version	string

RepositoryResourceParameters

Object

名称	类型	说明
refName	string
token	string	这是连接到存储库时要使用的安全令牌。
tokenType	string	自选。 这是给定令牌的类型。 如果未提供，则假定类型为“Bearer”。 注意：对 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