Leases - Add

Service:

Build

API Version:

7.1-preview.2

Fügt neue Leases für Pipelineausführungen hinzu.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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
body	NewRetentionLease[]

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	Ermöglicht den Zugriff auf Buildartefakte, einschließlich Buildergebnissen, Definitionen und Anforderungen, sowie die Möglichkeit, einen Build in eine Warteschlange zu stellen, Buildeigenschaften zu aktualisieren und Benachrichtigungen über Buildereignisse über Diensthaken zu empfangen.

Definitionen

Name	Beschreibung
NewRetentionLease	Erforderliche Informationen zum Erstellen einer neuen Aufbewahrungsleasing.
RetentionLease	Eine gültige Aufbewahrungsleasase verhindert, dass automatisierte Systeme eine Pipelineausführung löschen.

NewRetentionLease

Erforderliche Informationen zum Erstellen einer neuen Aufbewahrungsleasing.

Name	Typ	Beschreibung
daysValid	integer	Die Anzahl der Tage, die als gültig betrachtet werden müssen. Ein Aufbewahrungsleasing, das für mehr als 100 Jahre (36500 Tage) gültig ist, wird als "für immer" des Builds angezeigt.
definitionId	integer	Die Pipelinedefinition der Ausführung.
ownerId	string	Vom Benutzer bereitgestellte Zeichenfolge, die den Besitzer einer Aufbewahrungsleases identifiziert.
protectPipeline	boolean	Wenn festgelegt, verhindert diese Lease, dass die Pipeline gelöscht wird, solange die Lease noch gültig ist.
runId	integer	Die Pipeline wird zum Schutz ausgeführt.

RetentionLease

Eine gültige Aufbewahrungsleasase 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 Aufbewahrungsleases identifiziert.
protectPipeline	boolean	Wenn festgelegt, verhindert diese Lease, 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 der Leasingvertrag gültig ist.