Leases - Add

Service:

Build

API Version:

7.1-preview.2

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-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. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.2.

Text požadavku

Name	Typ	Description
body	NewRetentionLease[]

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_execute	Uděluje možnost přístupu 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 přijímat oznámení o událostech sestavení prostřednictvím připojení služeb.

Definice

Name	Description
NewRetentionLease	Požadované informace k 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 k vytvoření nového zapůjčení uchovávání informací.

Name	Typ	Description
daysValid	integer	Počet dnů, po které se má zapůjčení považovat za platné. Zapůjčení uchovávání s platností více než 100 let (36500 dnů) se zobrazí jako zachování buildu "navždy".
definitionId	integer	Definice kanálu spuštění.
ownerId	string	Řetězec zadaný uživatelem, 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, dokud je zapůjčení stále platné.
runId	integer	Kanál se spustí za účelem ochrany.

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	Kdy se zapůjčení vytvořilo.
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, dokud 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, kdy se zapůjčení považuje za platné.