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 のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.2' に設定する必要があります。

要求本文

名前	型	説明
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	このリースを設定すると、リースが有効な間もパイプラインが削除されなくなります。