Leases - Get Retention Leases By Owner Id
指定したエンティティが所有するすべてのリースを返します。必要に応じて、1 つのパイプライン定義にスコープを設定して実行します。
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 パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 組織の名前です。 |
|
project
|
path | True |
string |
プロジェクト ID またはプロジェクト名 |
|
api-version
|
query | True |
string |
使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.2' に設定する必要があります。 |
|
definition
|
query |
integer int32 |
検索を特定のパイプライン定義に制限する省略可能なパラメーター。 |
|
|
owner
|
query |
string |
||
|
run
|
query |
integer int32 |
検索を 1 つのパイプライン実行に制限する省略可能なパラメーター。 definitionId が必要です。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 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
| 名前 | 説明 |
|---|---|
| vso.build | ビルドの結果、定義、要求など、ビルド成果物にアクセスする機能と、サービス フックを介してビルド イベントに関する通知を受信する機能を付与します。 |
定義
RetentionLease
有効な保持リースを使用すると、自動化されたシステムがパイプラインの実行を削除できなくなります。
| 名前 | 型 | 説明 |
|---|---|---|
| createdOn |
string |
リースが作成されたとき。 |
| definitionId |
integer |
実行のパイプライン定義。 |
| leaseId |
integer |
このリースの一意識別子。 |
| ownerId |
string |
保持リースの所有者を識別する一意でない文字列。 |
| protectPipeline |
boolean |
このリースを設定すると、リースがまだ有効な間にパイプラインが削除されるのも防ぐことができます。 |
| runId |
integer |
このリースによって保護されたパイプライン実行。 |
| validUntil |
string |
リースが有効と見なされる最終日。 |