Leases - Get Retention Leases By Owner Id
傳回指定實體所擁有的任何租用，選擇性地限定為單一管線定義並執行。
GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?api-version=7.1-preview.2GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?ownerId={ownerId}&definitionId={definitionId}&runId={runId}&api-version=7.1-preview.2URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
|
project
|
path | True |
string |
專案識別碼或專案名稱 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 '7.1-preview.2'，以使用此版本的 API。 |
|
definition
|
query |
integer int32 |
選擇性參數，可限制搜尋至特定的管線定義。 |
|
|
owner
|
query |
string |
||
|
run
|
query |
integer int32 |
選擇性參數，將搜尋限制為單一管線執行。 需要 definitionId。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
成功作業 |
安全性
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 | 授與存取組建成品的能力，包括建置結果、定義和要求，以及能夠透過服務勾點接收有關建置事件的通知。 |
定義
RetentionLease
有效的保留租用可防止自動化系統刪除管線執行。
| 名稱 | 類型 | Description |
|---|---|---|
| createdOn |
string |
建立租用時。 |
| definitionId |
integer |
執行的管線定義。 |
| leaseId |
integer |
此租用的唯一識別碼。 |
| ownerId |
string |
識別保留租用擁有者的非唯一字串。 |
| protectPipeline |
boolean |
如果設定，此租用也會防止在租用仍然有效時刪除管線。 |
| runId |
integer |
此租用所保護的管線執行。 |
| validUntil |
string |
租用的最後一天會被視為有效。 |