Udostępnij za pośrednictwem


Leases - Get Retention Leases By Owner Id

Zwraca wszystkie dzierżawy należące do określonej jednostki, opcjonalnie ograniczone do pojedynczej definicji i uruchomienia potoku.

GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?api-version=7.1-preview.2
GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?ownerId={ownerId}&definitionId={definitionId}&runId={runId}&api-version=7.1-preview.2

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
organization
path True

string

Nazwa organizacji usługi Azure DevOps.

project
path True

string

Identyfikator projektu lub nazwa projektu

api-version
query True

string

Wersja interfejsu API do użycia. Ta wersja interfejsu API powinna być ustawiona na wartość "7.1-preview.2".

definitionId
query

integer

int32

Opcjonalny parametr ograniczający wyszukiwanie do określonej definicji potoku.

ownerId
query

string

runId
query

integer

int32

Opcjonalny parametr ograniczający wyszukiwanie do pojedynczego uruchomienia potoku. Wymaga identyfikatora definitionId.

Odpowiedzi

Nazwa Typ Opis
200 OK

RetentionLease[]

operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa Opis
vso.build Umożliwia dostęp do artefaktów kompilacji, w tym wyników kompilacji, definicji i żądań oraz możliwość odbierania powiadomień o zdarzeniach kompilacji za pośrednictwem punktów zaczepienia usługi.

Definicje

RetentionLease

Prawidłowa dzierżawa przechowywania uniemożliwia automatyczne systemy usuwania przebiegu potoku.

Nazwa Typ Opis
createdOn

string

Po utworzeniu dzierżawy.

definitionId

integer

Definicja potoku przebiegu.

leaseId

integer

Unikatowy identyfikator tej dzierżawy.

ownerId

string

Ciąg inny niż unikatowy, który identyfikuje właściciela dzierżawy przechowywania.

protectPipeline

boolean

Jeśli ta dzierżawa zostanie ustawiona, uniemożliwi również usunięcie potoku, gdy dzierżawa jest nadal prawidłowa.

runId

integer

Potok jest chroniony przez tę dzierżawę.

validUntil

string

Ostatni dzień dzierżawy jest uznawany za prawidłowy.