Condividi tramite

Leases - Get Retention Leases By User Id

  • Riferimento
Servizio:
Build
Versione API:
7.1

Restituisce eventuali lease di proprietà dell'utente specificato, con ambito facoltativo a una singola definizione di pipeline ed esecuzione.

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

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 progetto
api-version
 query True

string

Versione dell'API da usare. Deve essere impostato su '7.1' per usare questa versione dell'API.
userOwnerId
 query True

string (uuid)

ID utente da cercare.
definitionId
 query

integer (int32)

Parametro facoltativo per limitare la ricerca a una definizione di pipeline specifica.
runId
 query

integer (int32)

Parametro facoltativo per limitare la ricerca a una singola esecuzione della pipeline. Richiede definitionId.

Risposte

Nome Tipo Descrizione
200 OK

RetentionLease[]

operazione riuscita

Sicurezza

oauth2

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: 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

Ambiti

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

Object

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

Nome Tipo Descrizione
createdOn

string (date-time)

Al momento della creazione del lease.
definitionId

integer (int32)

Definizione della pipeline dell'esecuzione.
leaseId

integer (int32)

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 (int32)

La pipeline viene eseguita protetta da questo lease.
validUntil

string (date-time)

L'ultimo giorno in cui il lease è considerato valido.