Condividi tramite


Leases - Get Retention Leases By Minimal Retention Leases

Restituisce tutti i lease corrispondenti all'oggetto MinimalRetentionLeases specificato

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
organization
path True

string

Nome dell'organizzazione di Azure DevOps.

project
path True

string

ID progetto o nome del progetto

api-version
query True

string

Versione dell'API da usare. Deve essere impostato su '7.1-preview.2' per usare questa versione dell'API.

leasesToFetch
query True

string

array (MinimalRetentionLease)

Elenco di elementi MinimalRetentionLeas serializzati JSON separati da '|'

Risposte

Nome Tipo Descrizione
200 OK

RetentionLease[]

operazione riuscita

Sicurezza

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

Nome Descrizione
vso.build Concede la possibilità di accedere agli artefatti di compilazione, inclusi i risultati di compilazione, le definizioni e le richieste e la possibilità di ricevere notifiche sugli eventi di compilazione tramite hook del servizio.

Definizioni

RetentionLease

Un lease di conservazione valido impedisce ai sistemi automatizzati di eliminare un'esecuzione della pipeline.

Nome Tipo Descrizione
createdOn

string

Quando è stato creato il lease.

definitionId

integer

Definizione della pipeline dell'esecuzione.

leaseId

integer

Identificatore univoco per questo lease.

ownerId

string

Stringa non univoca che identifica il proprietario di un lease di conservazione.

protectPipeline

boolean

Se impostato, questo lease impedirà anche l'eliminazione della pipeline mentre il lease è ancora valido.

runId

integer

La pipeline viene eseguita protetta da questo lease.

validUntil

string

L'ultimo giorno il lease viene considerato valido.