Freigeben über

Leases - Get Retention Leases By Owner Id

  • Referenz
Service:
Build
API Version:
7.1-preview.2

Gibt alle Leases im Besitz der angegebenen Entität zurück, die optional auf eine einzelne Pipelinedefinition und ausführung ausgerichtet sind.

GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?api-version=7.1-preview.2
With optional parameters: 
GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?ownerId={ownerId}&definitionId={definitionId}&runId={runId}&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.
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

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 Ermöglicht den Zugriff auf Buildartefakte, einschließlich Buildergebnissen, Definitionen und Anforderungen, sowie die Möglichkeit, Benachrichtigungen über Buildereignisse über Diensthooks zu empfangen.

Definitionen

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.