Leases - Get
リース ID を指定して、保持リースの詳細を返します。
GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases/{leaseId}?api-version=7.1-preview.2URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
lease
|
path | True |
integer int32 |
|
|
organization
|
path | True |
string |
Azure DevOps 組織の名前です。 |
|
project
|
path | True |
string |
プロジェクト ID またはプロジェクト名 |
|
api-version
|
query | True |
string |
使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.2' に設定する必要があります。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 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 |
リースが有効と見なされる最終日。 |