Udostępnij za pośrednictwem


Leases - Get Retention Leases By User Id

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

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

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. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.

userOwnerId
query True

string (uuid)

Identyfikator użytkownika do wyszukania.

definitionId
query

integer (int32)

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

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

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

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 uruchomienia potoku.

Nazwa Typ Opis
createdOn

string (date-time)

Po utworzeniu dzierżawy.

definitionId

integer (int32)

Definicja potoku przebiegu.

leaseId

integer (int32)

Unikatowy identyfikator tej dzierżawy.

ownerId

string

Bez unikatowego ciągu identyfikującego 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 (int32)

Przebieg potoku chroniony przez tę dzierżawę.

validUntil

string (date-time)

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