Sdílet prostřednictvím


Leases - Get Retention Leases By Owner Id

Vrátí všechna zapůjčení vlastněná zadanou entitou, volitelně vymezená na jednu definici kanálu a spuštění.

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 identifikátoru URI

Name V Vyžadováno Typ Description
organization
path True

string

Název organizace Azure DevOps.

project
path True

string

ID projektu nebo název projektu

api-version
query True

string

Verze rozhraní API, která se má použít. Tato verze rozhraní API by měla být nastavená na 7.1-preview.2.

definitionId
query

integer

int32

Volitelný parametr pro omezení vyhledávání na konkrétní definici kanálu.

ownerId
query

string

runId
query

integer

int32

Volitelný parametr pro omezení vyhledávání na jedno spuštění kanálu. Vyžaduje definitionId.

Odpovědi

Name Typ Description
200 OK

RetentionLease[]

úspěšná operace

Zabezpečení

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 Description
vso.build Uděluje možnost přístupu k artefaktům sestavení, včetně výsledků sestavení, definic a požadavků, a možnost přijímat oznámení o událostech sestavení prostřednictvím volání služeb.

Definice

RetentionLease

Platné zapůjčení uchovávání informací zabraňuje automatizovaným systémům odstranit spuštění kanálu.

Name Typ Description
createdOn

string

Kdy bylo zapůjčení vytvořeno.

definitionId

integer

Definice kanálu spuštění.

leaseId

integer

Jedinečný identifikátor pro toto zapůjčení.

ownerId

string

Ne jedinečný řetězec, který identifikuje vlastníka zapůjčení uchovávání informací.

protectPipeline

boolean

Pokud je toto zapůjčení nastavené, zabrání také odstranění kanálu v době, kdy je zapůjčení stále platné.

runId

integer

Kanál běží chráněný tímto zapůjčením.

validUntil

string

Poslední den zapůjčení se považuje za platné.