Leases - Update

参考

Service:: Build

API Version:: 7.1-preview.2

汇报保留租约的持续时间或管道保护状态。

PATCH https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases/{leaseId}?api-version=7.1-preview.2

URI 参数

名称	在	必需	类型	说明
leaseId	path	True	integer int32	要更新的租约的 ID。
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。应将其设置为“7.1-preview.2”才能使用此版本的 API。

请求正文

名称	类型	说明
daysValid	integer	认为租约有效的天数。有效期超过 100 年 (36500 天的保留租约) 将显示为“永久”保留生成。
protectPipeline	boolean	如果设置了此租约，则此租约还将阻止在租约仍然有效时删除管道。

响应

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

安全性

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

定义

名称	说明
RetentionLease	有效的保留租约可防止自动化系统删除管道运行。
RetentionLeaseUpdate	对保留租约的保留参数的更新。

RetentionLease

有效的保留租约可防止自动化系统删除管道运行。

名称	类型	说明
createdOn	string	创建租约时。
definitionId	integer	运行的管道定义。
leaseId	integer	此租约的唯一标识符。
ownerId	string	标识保留租约所有者的非唯一字符串。
protectPipeline	boolean	如果设置了此租约，则此租约还将阻止在租约仍然有效时删除管道。
runId	integer	管道运行受此租约保护。
validUntil	string	租约被视为有效的最后一天。

RetentionLeaseUpdate

对保留租约的保留参数的更新。

名称	类型	说明
daysValid	integer	认为租约有效的天数。有效期超过 100 年 (36500 天的保留租约) 将显示为“永久”保留生成。
protectPipeline	boolean	如果设置了此租约，则此租约还将阻止在租约仍然有效时删除管道。

通过