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 パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
project	path	True	string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.2' に設定する必要があります。

要求本文

名前	型	説明
body	NewRetentionLease[]

応答

名前	型	説明
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	ビルドの結果、定義、要求など、ビルド成果物にアクセスする機能、ビルドのキューに登録する機能、ビルド プロパティを更新する機能、およびサービス フックを介してビルド イベントに関する通知を受け取る機能を付与します。

定義

名前	説明
NewRetentionLease	新しい保持リースを作成するために必要な情報。
RetentionLease	有効な保持リースを使用すると、自動化されたシステムがパイプラインの実行を削除できなくなります。

NewRetentionLease

新しい保持リースを作成するために必要な情報。

名前	型	説明
daysValid	integer	リースを有効と見なす日数。 100 年以上 (36500 日) 有効な保持リースは、ビルドを "永遠に" 保持すると表示されます。
definitionId	integer	実行のパイプライン定義。
ownerId	string	保持リースの所有者を識別するユーザー指定の文字列。
protectPipeline	boolean	このリースを設定すると、リースがまだ有効な間にパイプラインが削除されるのも防ぐことができます。
runId	integer	パイプラインが実行され、保護されます。

RetentionLease

有効な保持リースを使用すると、自動化されたシステムがパイプラインの実行を削除できなくなります。

名前	型	説明
createdOn	string	リースが作成されたとき。
definitionId	integer	実行のパイプライン定義。
leaseId	integer	このリースの一意識別子。
ownerId	string	保持リースの所有者を識別する一意でない文字列。
protectPipeline	boolean	このリースを設定すると、リースがまだ有効な間にパイプラインが削除されるのも防ぐことができます。
runId	integer	このリースによって保護されたパイプライン実行。
validUntil	string	リースが有効と見なされる最終日。