Freigeben über


Leases - Add

Fügt neue Leases für Pipelineläufe hinzu.

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

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" 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

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

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 Dienst-Hooks zu empfangen.

Definitionen

Name Beschreibung
NewRetentionLease

Erforderliche Informationen zum Erstellen einer neuen Aufbewahrungs-Lease.

RetentionLease

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

NewRetentionLease

Erforderliche Informationen zum Erstellen einer neuen Aufbewahrungs-Lease.

Name Typ Beschreibung
daysValid

integer (int32)

Die Anzahl der Tage, die als Gültiger Leasingvertrag betrachtet werden sollen. Eine Aufbewahrungslease, die länger als 100 Jahre gültig ist (36500 Tage), wird als Aufbewahrung des Builds "für immer" angezeigt.

definitionId

integer (int32)

Die Pipelinedefinition der Ausführung.

ownerId

string

Vom Benutzer bereitgestellte Zeichenfolge, die den Besitzer einer Aufbewahrungslease identifiziert.

protectPipeline

boolean

Wenn festgelegt, verhindert diese Lease auch, dass die Pipeline gelöscht wird, während die Lease noch gültig ist.

runId

integer (int32)

Die Pipeline wird ausgeführt, um sie zu schützen.

RetentionLease

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

Name Typ Beschreibung
createdOn

string (date-time)

Wann die Lease erstellt wurde.

definitionId

integer (int32)

Die Pipelinedefinition der Ausführung.

leaseId

integer (int32)

Der eindeutige Bezeichner für diese Lease.

ownerId

string

Nicht eindeutige Zeichenfolge, die den Besitzer einer Aufbewahrungslease identifiziert.

protectPipeline

boolean

Wenn festgelegt, verhindert diese Lease auch, dass die Pipeline gelöscht wird, während die Lease noch gültig ist.

runId

integer (int32)

Die Pipeline wird durch diese Lease geschützt.

validUntil

string (date-time)

Der letzte Tag, an dem der Leasingvertrag gültig ist.