Leases - Add

Service:

Build

API Version:

7.1-preview.2

新增管線執行的新租用。

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

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path	True	string	專案識別碼或專案名稱
api-version	query	True	string	要使用的 API 版本。 這應該設定為 '7.1-preview.2'，以使用此版本的 API。

要求本文

名稱	類型	Description
body	NewRetentionLease[]

回應

名稱	類型	Description
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

名稱	Description
vso.build_execute	授與存取組建成品的能力，包括建置結果、定義和要求，以及能夠將組建排入佇列、更新組建屬性，以及能夠透過服務勾點接收有關建置事件的通知。

定義

名稱	Description
NewRetentionLease	建立新保留租用的必要資訊。
RetentionLease	有效的保留租用可防止自動化系統刪除管線執行。

NewRetentionLease

建立新保留租用的必要資訊。

名稱	類型	Description
daysValid	integer	考慮租用有效天數。 36500 天超過 100 (年的保留租用) 會顯示為保留組建「永久」。
definitionId	integer	執行的管線定義。
ownerId	string	使用者提供的字串，可識別保留租用的擁有者。
protectPipeline	boolean	如果設定，此租用也會防止在租用仍然有效時刪除管線。
runId	integer	要保護的管線執行。

RetentionLease

有效的保留租用可防止自動化系統刪除管線執行。

名稱	類型	Description
createdOn	string	建立租用時。
definitionId	integer	執行的管線定義。
leaseId	integer	此租用的唯一識別碼。
ownerId	string	識別保留租用擁有者的非唯一字串。
protectPipeline	boolean	如果設定，此租用也會防止在租用仍然有效時刪除管線。
runId	integer	此租用所保護的管線執行。
validUntil	string	租用的最後一天會被視為有效。