Leases - Update

Service:

Build

API Version:

7.1-preview.2

Updates die Dauer oder den Pipelineschutz status einer Aufbewahrungsleasase.

PATCH https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases/{leaseId}?api-version=7.1-preview.2

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
leaseId	path	True	integer int32	Die ID der zu aktualisierenden Lease.
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path	True	string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.2" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
daysValid	integer	Die Anzahl der Tage, für die die Lease gültig ist. Ein Aufbewahrungsleasing, das länger als 100 Jahre (36500 Tage) gültig ist, wird als "für immer" beibehalten angezeigt.
protectPipeline	boolean	Wenn diese Einstellung festgelegt ist, verhindert diese Lease auch, dass die Pipeline gelöscht wird, solange die Lease noch gültig ist.

Antworten

Name	Typ	Beschreibung
200 OK	RetentionLease	Erfolgreicher Vorgang

Sicherheit

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

Name	Beschreibung
vso.build_execute	Gewährt die Möglichkeit, auf Buildartefakte zuzugreifen, einschließlich Buildergebnissen, Definitionen und Anforderungen, sowie die Möglichkeit, einen Build in die Warteschlange zu stellen, Buildeigenschaften zu aktualisieren und Benachrichtigungen über Buildereignisse über Diensthooks zu empfangen.

Definitionen

Name	Beschreibung
RetentionLease	Eine gültige Aufbewahrungslease verhindert, dass automatisierte Systeme eine Pipelineausführung löschen.
RetentionLeaseUpdate	Eine Aktualisierung der Aufbewahrungsparameter einer Aufbewahrungsleases.

RetentionLease

Eine gültige Aufbewahrungslease verhindert, dass automatisierte Systeme eine Pipelineausführung löschen.

Name	Typ	Beschreibung
createdOn	string	Wann die Lease erstellt wurde.
definitionId	integer	Die Pipelinedefinition der Ausführung.
leaseId	integer	Der eindeutige Bezeichner für diese Lease.
ownerId	string	Nicht eindeutige Zeichenfolge, die den Besitzer einer Aufbewahrungsleasase identifiziert.
protectPipeline	boolean	Wenn diese Einstellung festgelegt ist, verhindert diese Lease auch, dass die Pipeline gelöscht wird, solange die Lease noch gültig ist.
runId	integer	Die Pipeline wird durch diese Lease geschützt ausgeführt.
validUntil	string	Der letzte Tag, an dem die Lease als gültig gilt.

RetentionLeaseUpdate

Eine Aktualisierung der Aufbewahrungsparameter einer Aufbewahrungsleases.

Name	Typ	Beschreibung
daysValid	integer	Die Anzahl der Tage, für die die Lease gültig ist. Ein Aufbewahrungsleasing, das länger als 100 Jahre (36500 Tage) gültig ist, wird als "für immer" beibehalten angezeigt.
protectPipeline	boolean	Wenn diese Einstellung festgelegt ist, verhindert diese Lease auch, dass die Pipeline gelöscht wird, solange die Lease noch gültig ist.