Builds - Queue

Service:

Build

API Version:

7.1-preview.7

将生成排队

POST https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=7.1-preview.7

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/build/builds?ignoreWarnings={ignoreWarnings}&checkInTicket={checkInTicket}&sourceBuildId={sourceBuildId}&definitionId={definitionId}&api-version=7.1-preview.7

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。 应将其设置为“7.1-preview.7”才能使用此版本的 API。
checkInTicket	query		string
definitionId	query		integer int32	用于在没有正文的情况下将生成排队的可选定义 ID。 如果存在有效的正文，则忽略
ignoreWarnings	query		boolean
sourceBuildId	query		integer int32

请求正文

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
agentSpecification	AgentSpecification	生成的代理规范。
appendCommitMessageToRunName	boolean	在 UI 中将提交消息追加到 BuildNumber。
buildNumber	string	内部版本号/内部版本名称。
buildNumberRevision	integer	内部版本号修订。
controller	BuildController	生成控制器。 仅当定义类型为 Xaml 时，才会设置此值。
definition	DefinitionReference	与生成关联的定义。
deleted	boolean	指示是否已删除生成。
deletedBy	IdentityRef	删除生成的进程或人员的标识。
deletedDate	string	删除生成的日期。
deletedReason	string	如何删除生成的说明。
demands	Demand[]	表示此生成所需的代理功能的需求列表。
finishTime	string	生成完成的时间。
id	integer	生成的 ID。
lastChangedBy	IdentityRef	表示上次更改生成的进程或人员的标识。
lastChangedDate	string	上次更改生成的日期。
logs	BuildLogReference	有关生成日志的信息。
orchestrationPlan	TaskOrchestrationPlanReference	生成的业务流程计划。
parameters	string	生成的参数。
plans	TaskOrchestrationPlanReference[]	与生成 (生成、清理) 关联的业务流程计划
priority	QueuePriority	生成的优先级。
project	TeamProjectReference	团队项目。
properties	PropertiesCollection	类将属性包表示为键值对的集合。 接受所有基元类型的值 (除 TypeCode != TypeCode.Object) 以外的 DBNull 任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新优化为 String。 Byte[] 预期为 base64 编码字符串。
quality	string	xaml 生成的质量 (好、坏等)
queue	AgentPoolQueue	队列。 仅当定义类型为“生成”时，才会设置此值。 警告：此字段已弃用，与作业队列不对应。
queueOptions	QueueOptions	用于将生成排队的其他选项。
queuePosition	integer	生成在队列中的当前位置。
queueTime	string	生成排队的时间。
reason	BuildReason	创建生成的原因。
repository	BuildRepository	存储库。
requestedBy	IdentityRef	将生成排队的标识。
requestedFor	IdentityRef	代表其生成排队的标识。
result	BuildResult	生成结果。
retainedByRelease	boolean	指示版本是否由发布保留。
sourceBranch	string	源分支。
sourceVersion	string	源版本。
startTime	string	开始生成的时间。
status	BuildStatus	生成的状态。
tags	string[]
templateParameters	object	模板表达式计算的参数
triggerInfo	object	有关触发生成的内容的 Sourceprovider 特定信息
triggeredByBuild	Build	通过生成完成触发器触发此生成的生成。
uri	string	生成的 URI。
url	string	生成的 REST URL。
validationResults	BuildRequestValidationResult[]	表示验证生成请求的结果。

响应

名称	类型	说明
200 OK	Build	成功的操作

安全性

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	授予访问生成项目（包括生成结果、定义和请求）的能力，以及对生成进行排队、更新生成属性以及通过服务挂钩接收有关生成事件的通知的能力。

定义

名称	说明
AgentPoolQueue	表示运行生成的队列。
AgentSpecification	池提供程序定义的代理的规范。
Build	生成的数据表示形式。
BuildController
BuildLogReference	表示对生成日志的引用。
BuildReason	创建生成的原因。
BuildRepository	表示生成定义使用的存储库。
BuildRequestValidationResult	表示验证生成请求的结果。
BuildResult	生成结果。
BuildStatus	生成状态。
ControllerStatus	控制器的状态。
DefinitionQueueStatus	一个 值，该值指示是否可以针对此定义对生成进行排队。
DefinitionReference	表示对定义的引用。
DefinitionType	定义的类型。
Demand	表示定义或生成使用的需求。
IdentityRef
ProjectState	项目状态。
ProjectVisibility	项目可见性。
PropertiesCollection	类将属性包表示为键值对的集合。 接受除 之外DBNull的所有基元类型的值 (具有TypeCode != TypeCode.Object) 的任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
QueueOptions	用于将生成排队的其他选项。
QueuePriority	生成的优先级。
ReferenceLinks	表示 REST 引用链接集合的类。
TaskAgentPoolReference	表示对代理池的引用。
TaskOrchestrationPlanReference	表示对业务流程计划的引用。
TeamProjectReference	表示对 TeamProject 的浅表引用。
ValidationResult	结果。

AgentPoolQueue

表示运行生成的队列。

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
id	integer	队列的 ID。
name	string	队列的名称。
pool	TaskAgentPoolReference	此队列使用的池。
url	string	指向资源的完整 http 链接。

AgentSpecification

池提供程序定义的代理的规范。

名称	类型	说明
identifier	string	代理规范唯一标识符。

Build

生成的数据表示形式。

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
agentSpecification	AgentSpecification	生成的代理规范。
appendCommitMessageToRunName	boolean	在 UI 中将提交消息追加到 BuildNumber。
buildNumber	string	生成的内部版本号/名称。
buildNumberRevision	integer	内部版本号修订。
controller	BuildController	生成控制器。 仅当定义类型为 Xaml 时，才会设置此值。
definition	DefinitionReference	与生成关联的定义。
deleted	boolean	指示是否已删除生成。
deletedBy	IdentityRef	删除生成的进程或人员的标识。
deletedDate	string	删除生成的日期。
deletedReason	string	有关如何删除生成的说明。
demands	Demand[]	表示此生成所需的代理功能的要求列表。
finishTime	string	生成完成的时间。
id	integer	生成的 ID。
lastChangedBy	IdentityRef	表示上次更改生成的进程或人员的标识。
lastChangedDate	string	上次更改生成的日期。
logs	BuildLogReference	有关生成日志的信息。
orchestrationPlan	TaskOrchestrationPlanReference	生成的业务流程计划。
parameters	string	生成的参数。
plans	TaskOrchestrationPlanReference[]	与生成 (生成、清理) 关联的业务流程计划
priority	QueuePriority	生成的优先级。
project	TeamProjectReference	团队项目。
properties	PropertiesCollection	类将属性包表示为键值对的集合。 接受除 之外DBNull的所有基元类型的值 (具有TypeCode != TypeCode.Object) 的任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
quality	string	xaml 生成的质量 (好、坏等)
queue	AgentPoolQueue	队列。 仅当定义类型为“生成”时，才会设置此值。 警告：此字段已弃用，与作业队列不对应。
queueOptions	QueueOptions	用于将生成排队的其他选项。
queuePosition	integer	生成在队列中的当前位置。
queueTime	string	生成排队的时间。
reason	BuildReason	创建生成的原因。
repository	BuildRepository	存储库。
requestedBy	IdentityRef	将生成排队的标识。
requestedFor	IdentityRef	代表其生成排队的标识。
result	BuildResult	生成结果。
retainedByRelease	boolean	指示版本是否由发布保留。
sourceBranch	string	源分支。
sourceVersion	string	源版本。
startTime	string	启动生成的时间。
status	BuildStatus	生成的状态。
tags	string[]
templateParameters	object	模板表达式计算的参数
triggerInfo	object	有关触发生成因素的特定于 Sourceprovider 的信息
triggeredByBuild	Build	通过生成完成触发器触发此生成的生成。
uri	string	生成的 URI。
url	string	生成的 REST URL。
validationResults	BuildRequestValidationResult[]	表示验证生成请求的结果。

BuildController

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
createdDate	string	创建控制器的日期。
description	string	控制器的说明。
enabled	boolean	指示是否启用控制器。
id	integer	资源的 ID
name	string	链接资源的名称 (定义名称、控制器名称等)
status	ControllerStatus	控制器的状态。
updatedDate	string	控制器的上次更新日期。
uri	string	控制器的 URI。
url	string	指向资源的完整 http 链接

BuildLogReference

表示对生成日志的引用。

名称	类型	说明
id	integer	日志的 ID。
type	string	日志位置的类型。
url	string	指向日志资源的完整链接。

BuildReason

创建生成的原因。

名称	类型	说明
all	string	所有原因。
batchedCI	string	已为触发器 TriggerType.BatchedContinuousIntegration 启动生成。
buildCompletion	string	生成是在另一个生成完成时启动的。
checkInShelveset	string	已为触发器 ContinuousIntegrationType.Gated 启动生成。
individualCI	string	已为触发器 TriggerType.ContinuousIntegration 启动生成。
manual	string	生成是手动启动的。
none	string	没有理由。 不应使用此值。
pullRequest	string	生成由拉取请求启动。 在资源版本 3 中添加。
resourceTrigger	string	生成是在管道中的资源触发它时启动的
schedule	string	已为触发器 TriggerType.Schedule 启动生成。
scheduleForced	string	已为触发器 TriggerType.ScheduleForced 启动生成。
triggered	string	出于保留策略目的触发了生成。
userCreated	string	生成由用户创建。
validateShelveset	string	已手动启动生成，以便进行专用验证。

BuildRepository

表示生成定义使用的存储库。

名称	类型	说明
checkoutSubmodules	boolean	指示是否签出子模块。
clean	string	指示从存储库获取代码时是否清理目标文件夹。
defaultBranch	string	默认分支的名称。
id	string	存储库的 ID。
name	string	存储库的友好名称。
properties	object
rootFolder	string	根文件夹。
type	string	存储库的类型。
url	string	存储库的 URL。

BuildRequestValidationResult

表示验证生成请求的结果。

名称	类型	说明
message	string	与结果关联的消息。
result	ValidationResult	结果。

BuildResult

生成结果。

名称	类型	说明
canceled	string	生成在开始前已取消。
failed	string	生成未成功完成。
none	string	无结果
partiallySucceeded	string	生成成功完成编译，但出现其他错误。
succeeded	string	生成已成功完成。

BuildStatus

生成状态。

名称	类型	说明
all	string	所有状态。
cancelling	string	生成正在取消
completed	string	生成已完成。
inProgress	string	生成当前正在进行中。
none	string	无状态。
notStarted	string	生成尚未启动。
postponed	string	生成在队列中处于非活动状态。

ControllerStatus

控制器的状态。

名称	类型	说明
available	string	指示生成控制器当前可用。
offline	string	指示生成控制器已使自身脱机。
unavailable	string	指示无法联系生成控制器。

DefinitionQueueStatus

一个 值，该值指示是否可以针对此定义对生成进行排队。

名称	类型	说明
disabled	string	禁用后，定义队列将不允许用户将生成排队，系统也不会将计划、封闭或持续集成生成排队。 系统不会启动队列中已有的生成。
enabled	string	启用定义队列后，用户可对生成进行排队，系统将对计划、封闭和持续集成生成进行排队，排队的生成将由系统启动。
paused	string	暂停时，定义队列允许用户对生成进行排队，系统将对计划、封闭和持续集成生成进行排队。 系统不会启动队列中的生成。

DefinitionReference

表示对定义的引用。

名称	类型	说明
createdDate	string	此版本的定义的创建日期。
id	integer	被引用定义的 ID。
name	string	引用的定义的名称。
path	string	定义的文件夹路径。
project	TeamProjectReference	对项目的引用。
queueStatus	DefinitionQueueStatus	一个 值，该值指示是否可以针对此定义对生成进行排队。
revision	integer	定义修订号。
type	DefinitionType	定义的类型。
uri	string	定义的 URI。
url	string	定义的 REST URL。

DefinitionType

定义的类型。

名称	类型	说明
build	string
xaml	string

Demand

表示定义或生成使用的需求。

名称	类型	说明
name	string	需求引用的功能的名称。
value	string	所需的值。

IdentityRef

名称	类型	说明
_links	ReferenceLinks	此字段包含零个或多个有关图形主题的有趣链接。 可以调用这些链接来获取有关此图主题的其他关系或更详细的信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方法。 此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“头像”条目中可用
inactive	boolean	已弃用 - 可通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断 (描述符.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 未在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 改用 Domain+PrincipalName
url	string	此 URL 是指向此图主题的源资源的完整路由。

ProjectState

项目状态。

名称	类型	说明
all	string	所有项目，不考虑状态，已删除。
createPending	string	项目已排队等待创建，但该过程尚未启动。
deleted	string	已删除项目。
deleting	string	正在删除 Project。
new	string	项目正在创建过程中。
unchanged	string	项目尚未更改。
wellFormed	string	项目已完全创建并可供使用。

ProjectVisibility

项目可见性。

名称	类型	说明
private	string	项目仅对具有显式访问权限的用户可见。
public	string	项目对所有人都可见。

PropertiesCollection

类将属性包表示为键值对的集合。 接受除 之外DBNull的所有基元类型的值 (具有TypeCode != TypeCode.Object) 的任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。

名称	类型	说明
count	integer	集合中的属性计数。
item	object
keys	string[]	集合中的键集。
values	string[]	集合中的值集。

QueueOptions

用于将生成排队的其他选项。

名称	类型	说明
doNotRun	string	为生成创建计划 ID，不要运行它
none	string	无队列选项

QueuePriority

生成的优先级。

名称	类型	说明
aboveNormal	string	高于正常优先级。
belowNormal	string	低于正常优先级。
high	string	高优先级。
low	string	低优先级。
normal	string	正常优先级。

ReferenceLinks

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

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

TaskAgentPoolReference

表示对代理池的引用。

名称	类型	说明
id	integer	池 ID。
isHosted	boolean	一个 值，该值指示此池是否由服务管理。
name	string	池名称。

TaskOrchestrationPlanReference

表示对业务流程计划的引用。

名称	类型	说明
orchestrationType	integer	计划的类型。
planId	string	计划的 ID。

TeamProjectReference

表示对 TeamProject 的浅表引用。

名称	类型	说明
abbreviation	string	项目缩写。
defaultTeamImageUrl	string	默认团队标识图像的 URL。
description	string	如果有任何) ，项目说明 (。
id	string	项目标识符。
lastUpdateTime	string	Project 上次更新时间。
name	string	项目名称。
revision	integer	项目修订。
state	ProjectState	项目状态。
url	string	对象完整版本的 URL。
visibility	ProjectVisibility	项目可见性。

ValidationResult

结果。

名称	类型	说明
error	string
ok	string
warning	string