Definitions - Update

Service:

Build

API Version:

5.1

汇报现有定义。

PUT https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}?api-version=5.1

With optional parameters:

PUT https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}?secretsSourceDefinitionId={secretsSourceDefinitionId}&secretsSourceDefinitionRevision={secretsSourceDefinitionRevision}&api-version=5.1

URI 参数

名称	在	必需	类型	说明
definitionId	path	True	integer int32	定义的 ID。
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。 应将其设置为“5.1”才能使用此版本的 API。
secretsSourceDefinitionId	query		integer int32
secretsSourceDefinitionRevision	query		integer int32

请求正文

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
authoredBy	IdentityRef	定义的作者。
badgeEnabled	boolean	指示是否为此定义启用锁屏提醒。
buildNumberFormat	string	内部版本号格式。
comment	string	定义的保存时间注释。
createdDate	string	创建此版本的定义的日期。
demands	Demand[]	表示定义或生成使用的需求。
description	string	说明。
draftOf	DefinitionReference	对此定义为草稿的定义（如果这是草稿定义）的引用。
drafts	DefinitionReference[]	与此定义关联的草稿列表（如果这不是草稿定义）。
dropLocation	string	定义的放置位置。
id	integer	引用定义的 ID。
jobAuthorizationScope	BuildAuthorizationScope	根据此定义排队的生成的作业授权范围。
jobCancelTimeoutInMinutes	integer	对于用户为此定义取消的生成，作业取消超时 (以分钟为单位) 。
jobTimeoutInMinutes	integer	针对针对此定义排队的生成) ，作业执行超时 (以分钟为单位。
latestBuild	Build	生成的数据表示形式。
latestCompletedBuild	Build	生成的数据表示形式。
metrics	BuildMetric[]	表示有关系统中生成的元数据。
name	string	引用的定义的名称。
options	BuildOption[]	表示将可选行为应用于生成定义。
path	string	定义的文件夹路径。
process	BuildProcess	生成过程。
processParameters	ProcessParameters	此定义的进程参数。
project	TeamProjectReference	对项目的引用。
properties	PropertiesCollection	类将属性包表示为键值对的集合。 接受所有基元类型的值 (除 TypeCode != TypeCode.Object) 以外的 DBNull 任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新优化为 String。 Byte[] 预期为 base64 编码字符串。
quality	DefinitionQuality	定义文档的质量 (草稿等)
queue	AgentPoolQueue	生成的默认队列针对此定义运行。
queueStatus	DefinitionQueueStatus	一个 值，该值指示生成是否可针对此定义排队。
repository	BuildRepository	存储库。
retentionRules	RetentionPolicy[]	表示生成定义的保留策略。
revision	integer	定义修订号。
tags	string[]
triggers	BuildTrigger[]	表示 buld 定义的触发器。
type	DefinitionType	定义的类型。
uri	string	定义的 URI。
url	string	定义的 REST URL。
variableGroups	VariableGroup[]	表示变量组。
variables	<string,  BuildDefinitionVariable>

响应

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

安全性

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	池提供程序定义的代理的规范。
AuthorizationHeader
Build	生成的数据表示形式。
BuildAuthorizationScope	根据此定义排队的生成的作业授权范围。
BuildController
BuildDefinition	表示生成定义。
BuildDefinitionVariable	表示生成定义使用的变量。
BuildLogReference	表示对生成日志的引用。
BuildMetric	表示有关系统中生成的元数据。
BuildOption	表示将可选行为应用于生成定义。
BuildOptionDefinitionReference	表示对生成选项定义的引用。
BuildProcess	表示生成过程。
BuildReason	创建生成的原因。
BuildRepository	表示生成定义使用的存储库。
BuildRequestValidationResult	表示验证生成请求的结果。
BuildResult	生成结果。
BuildStatus	生成状态。
BuildTrigger	表示 buld 定义的触发器。
ControllerStatus	控制器的状态。
DataSourceBindingBase	表示服务终结点请求的数据源绑定。
DefinitionQuality	定义文档的质量 (草稿等)
DefinitionQueueStatus	一个 值，该值指示生成是否可针对此定义排队。
DefinitionReference	表示对定义的引用。
DefinitionTriggerType	触发器的类型。
DefinitionType	定义的类型。
Demand	表示定义或生成使用的需求。
IdentityRef
ProcessParameters
ProjectState	项目状态。
ProjectVisibility	项目可见性。
PropertiesCollection	类将属性包表示为键值对的集合。 接受所有基元类型的值 (除 TypeCode != TypeCode.Object) 以外的 DBNull 任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新优化为 String。 Byte[] 预期为 base64 编码字符串。
QueueOptions	用于将生成排队的其他选项。
QueuePriority	生成的优先级。
ReferenceLinks	表示 REST 引用链接集合的类。
RetentionPolicy	表示生成定义的保留策略。
TaskAgentPoolReference	表示对代理池的引用。
TaskInputDefinitionBase
TaskInputValidation
TaskOrchestrationPlanReference	表示对业务流程计划的引用。
TaskSourceDefinitionBase
TeamProjectReference	表示对 TeamProject 的浅表引用。
ValidationResult	结果。
VariableGroup	表示变量组。

AgentPoolQueue

表示用于运行生成的队列。

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

AgentSpecification

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

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

AuthorizationHeader

名称	类型	说明
name	string
value	string

Build

生成的数据表示形式。

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
agentSpecification	AgentSpecification	生成的代理规范。
buildNumber	string	内部版本号/内部版本名称。
buildNumberRevision	integer	内部版本号修订。
controller	BuildController	生成控制器。 仅当定义类型为 Xaml 时，才会设置此值。
definition	DefinitionReference	与生成关联的定义。
deleted	boolean	指示是否已删除生成。
deletedBy	IdentityRef	删除生成的进程或人员的标识。
deletedDate	string	删除生成的日期。
deletedReason	string	如何删除生成的说明。
demands	Demand[]	表示此生成所需的代理功能的需求列表。
finishTime	string	生成完成的时间。
id	integer	生成的 ID。
keepForever	boolean	指示保留策略是否应跳过生成。
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[]
triggerInfo	object	有关触发生成的内容的 Sourceprovider 特定信息
triggeredByBuild	Build	通过生成完成触发器触发此生成的生成。
uri	string	生成的 URI。
url	string	生成的 REST URL。
validationResults	BuildRequestValidationResult[]	表示验证生成请求的结果。

BuildAuthorizationScope

根据此定义排队的生成的作业授权范围。

名称	类型	说明
project	string	使用的标识应具有范围限定为生成定义所在的项目的生成服务帐户权限。 这对于将生成作业隔离到特定团队项目非常有用，以避免在生成期间意外升级特权攻击。
projectCollection	string	使用的标识应具有范围限定为项目集合的生成服务帐户权限。 当单个生成的资源分散在多个项目中时，这非常有用。

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 链接

BuildDefinition

表示生成定义。

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
authoredBy	IdentityRef	定义的作者。
badgeEnabled	boolean	指示是否为此定义启用锁屏提醒。
buildNumberFormat	string	内部版本号格式。
comment	string	定义的保存时间注释。
createdDate	string	创建此版本的定义的日期。
demands	Demand[]	表示定义或生成使用的需求。
description	string	说明。
draftOf	DefinitionReference	对此定义为草稿的定义（如果这是草稿定义）的引用。
drafts	DefinitionReference[]	与此定义关联的草稿列表（如果这不是草稿定义）。
dropLocation	string	定义的放置位置。
id	integer	引用定义的 ID。
jobAuthorizationScope	BuildAuthorizationScope	根据此定义排队的生成的作业授权范围。
jobCancelTimeoutInMinutes	integer	对于用户为此定义取消的生成，作业取消超时 (以分钟为单位) 。
jobTimeoutInMinutes	integer	针对针对此定义排队的生成) ，作业执行超时 (以分钟为单位。
latestBuild	Build	生成的数据表示形式。
latestCompletedBuild	Build	生成的数据表示形式。
metrics	BuildMetric[]	表示有关系统中生成的元数据。
name	string	引用的定义的名称。
options	BuildOption[]	表示将可选行为应用于生成定义。
path	string	定义的文件夹路径。
process	BuildProcess	生成过程。
processParameters	ProcessParameters	此定义的进程参数。
project	TeamProjectReference	对项目的引用。
properties	PropertiesCollection	类将属性包表示为键值对的集合。 接受所有基元类型的值 (除 TypeCode != TypeCode.Object) 以外的 DBNull 任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新优化为 String。 Byte[] 预期为 base64 编码字符串。
quality	DefinitionQuality	定义文档的质量 (草稿等)
queue	AgentPoolQueue	生成的默认队列针对此定义运行。
queueStatus	DefinitionQueueStatus	一个 值，该值指示生成是否可针对此定义排队。
repository	BuildRepository	存储库。
retentionRules	RetentionPolicy[]	表示生成定义的保留策略。
revision	integer	定义修订号。
tags	string[]
triggers	BuildTrigger[]	表示 buld 定义的触发器。
type	DefinitionType	定义的类型。
uri	string	定义的 URI。
url	string	定义的 REST URL。
variableGroups	VariableGroup[]	表示变量组。
variables	<string,  BuildDefinitionVariable>

BuildDefinitionVariable

表示生成定义使用的变量。

名称	类型	说明
allowOverride	boolean	指示是否可以在队列时设置值。
isSecret	boolean	指示变量的值是否为机密。
value	string	变量的值，

BuildLogReference

表示对生成日志的引用。

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

BuildMetric

表示有关系统中生成的元数据。

名称	类型	说明
date	string	范围的日期。
intValue	integer	值。
name	string	指标的名称。
scope	string	范围。

BuildOption

表示将可选行为应用于生成定义。

名称	类型	说明
definition	BuildOptionDefinitionReference	对生成选项的引用。
enabled	boolean	指示是否启用该行为。
inputs	object

BuildOptionDefinitionReference

表示对生成选项定义的引用。

名称	类型	说明
id	string	引用的生成选项的 ID。

BuildProcess

表示生成过程。

名称	类型	说明
type	integer	进程的类型。

BuildReason

创建生成的原因。

名称	类型	说明
all	string	所有原因。
batchedCI	string	已针对触发器 TriggerType.BatchedContinuousIntegration 启动生成。
buildCompletion	string	生成是在另一个生成完成时启动的。
checkInShelveset	string	已针对触发器 ContinuousIntegrationType.Gated 启动生成。
individualCI	string	已针对触发器 TriggerType.ContinuousIntegration 启动生成。
manual	string	生成是手动启动的。
none	string	没有理由。 不应使用此值。
pullRequest	string	生成由拉取请求启动。 在资源版本 3 中添加。
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	生成在队列中处于非活动状态。

BuildTrigger

表示 buld 定义的触发器。

名称	类型	说明
triggerType	DefinitionTriggerType	触发器的类型。

ControllerStatus

控制器的状态。

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

DataSourceBindingBase

表示服务终结点请求的数据源绑定。

名称	类型	说明
callbackContextTemplate	string	此数据源支持的分页格式 (ContinuationToken/SkipTop) 。
callbackRequiredTemplate	string	需要后续调用？
dataSourceName	string	获取或设置数据源的名称。
endpointId	string	获取或设置终结点 ID。
endpointUrl	string	获取或设置服务终结点的 URL。
headers	AuthorizationHeader[]	获取或设置授权标头。
initialContextTemplate	string	定义查询参数的初始值
parameters	object	获取或设置数据源的参数。
requestContent	string	获取或设置 http 请求正文
requestVerb	string	获取或设置 http 请求谓词
resultSelector	string	获取或设置结果选择器。
resultTemplate	string	获取或设置结果模板。
target	string	获取或设置数据源的目标。

DefinitionQuality

定义文档的质量 (草稿等)

名称	类型	说明
definition	string
draft	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。

DefinitionTriggerType

触发器的类型。

名称	类型	说明
all	string	所有类型。
batchedContinuousIntegration	string	应按指定的时间间隔一次启动多个更改集的生成。
batchedGatedCheckIn	string	应为每批检查启动验证生成。
buildCompletion	string	当另一个生成完成时，应触发生成。
continuousIntegration	string	应为每个变更集启动生成。
gatedCheckIn	string	应为每个检查启动验证生成。
none	string	仅手动生成。
pullRequest	string	创建或更新 GitHub 拉取请求时，应触发生成。 在资源版本 3 中添加
schedule	string	无论是否存在更改集，都应按指定的计划启动生成。

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	已弃用 - 可以从描述符的主题类型推断 (描述符.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断 (描述符.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 未在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 改用 Domain+PrincipalName
url	string	此 URL 是此图主题的源资源的完整路由。

ProcessParameters

名称	类型	说明
dataSourceBindings	DataSourceBindingBase[]	表示服务终结点请求的数据源绑定。
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectState

项目状态。

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

ProjectVisibility

项目可见性。

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

PropertiesCollection

类将属性包表示为键值对的集合。 接受所有基元类型的值 (除 TypeCode != TypeCode.Object) 以外的 DBNull 任何类型。 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	链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读。

RetentionPolicy

表示生成定义的保留策略。

名称	类型	说明
artifactTypesToDelete	string[]
artifacts	string[]
branches	string[]
daysToKeep	integer	保留生成的天数。
deleteBuildRecord	boolean	指示是否应删除生成记录本身。
deleteTestResults	boolean	指示是否删除与生成关联的测试结果。
minimumToKeep	integer	要保留的最小生成数。

TaskAgentPoolReference

表示对代理池的引用。

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

TaskInputDefinitionBase

名称	类型	说明
aliases	string[]
defaultValue	string
groupName	string
helpMarkDown	string
label	string
name	string
options	object
properties	object
required	boolean
type	string
validation	TaskInputValidation
visibleRule	string

TaskInputValidation

名称	类型	说明
expression	string	条件表达式
message	string	说明用户在验证失败时如何更正的消息

TaskOrchestrationPlanReference

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

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

TaskSourceDefinitionBase

名称	类型	说明
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

TeamProjectReference

表示对 TeamProject 的浅表引用。

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

ValidationResult

结果。

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

VariableGroup

表示变量组。

名称	类型	说明
alias	string	变量组的名称。
description	string	说明。
id	integer	变量组的 ID。
name	string	变量组的名称。
type	string	变量组的类型。
variables	<string,  BuildDefinitionVariable>