Sdílet prostřednictvím


Leases - Add

Přidá nové zapůjčení pro spuštění kanálu.

POST https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?api-version=7.1

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. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.

Text požadavku

Name Typ Description
body

NewRetentionLease[]

Odpovědi

Name Typ Description
200 OK

RetentionLease[]

úspěšná operace

Zabezpečení

oauth2

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

Rozsahy

Name Description
vso.build_execute Uděluje možnost získat přístup k artefaktům sestavení, včetně výsledků sestavení, definic a požadavků, a možnost zařadit sestavení do fronty, aktualizovat vlastnosti sestavení a možnost přijímat oznámení o událostech sestavení prostřednictvím volání služeb.

Definice

Name Description
NewRetentionLease

Požadované informace pro vytvoření nového zapůjčení uchovávání informací.

RetentionLease

Platné zapůjčení uchovávání brání automatizovaným systémům v odstranění spuštění kanálu.

NewRetentionLease

Požadované informace pro vytvoření nového zapůjčení uchovávání informací.

Name Typ Description
daysValid

integer (int32)

Počet dnů, po které je potřeba vzít v úvahu platnost zapůjčení Zapůjčení uchování platné po dobu delší než 100 let (36500 dní) se zobrazí jako zachování buildu "navždy".

definitionId

integer (int32)

Definice kanálu spuštění.

ownerId

string

Uživatelem zadaný řetězec, který identifikuje vlastníka zapůjčení uchovávání informací.

protectPipeline

boolean

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

runId

integer (int32)

Spuštění kanálu pro ochranu.

RetentionLease

Platné zapůjčení uchovávání brání automatizovaným systémům v odstranění spuštění kanálu.

Name Typ Description
createdOn

string (date-time)

Po vytvoření zapůjčení

definitionId

integer (int32)

Definice kanálu spuštění.

leaseId

integer (int32)

Jedinečný identifikátor tohoto 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í odstranění kanálu, i když je zapůjčení stále platné.

runId

integer (int32)

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

validUntil

string (date-time)

Poslední den, kdy je zapůjčení považováno za platné.