Freigeben über

Leases - Get Retention Leases By Owner Id

  • Referenz
Dienst:
Build
API-Version:
7.1

Gibt alle Leases zurück, die der angegebenen Entität gehören, optional auf eine einzelne Pipelinedefinition begrenzt und ausgeführt werden.

GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?api-version=7.1
Mit optionalen Parametern: 
GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?ownerId={ownerId}&definitionId={definitionId}&runId={runId}&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.
definitionId
 query

integer (int32)

Ein optionaler Parameter, um die Suche auf eine bestimmte Pipelinedefinition zu beschränken.
ownerId
 query

string

runId
 query

integer (int32)

Ein optionaler Parameter, um die Suche auf eine einzelne Pipelineausführung zu beschränken. Erfordert definitionId.

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 Gewährt die Möglichkeit, auf Buildartefakte zuzugreifen, einschließlich Buildergebnissen, Definitionen und Anforderungen sowie die Möglichkeit, Benachrichtigungen über Buildereignisse über Dienst-Hooks zu empfangen.

Definitionen

RetentionLease

Objekt

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.