Leases - Update

Riferimento

Servizio:: Build

Versione API:: 7.1

Aggiorna la durata o lo stato di protezione della pipeline di un lease di conservazione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
leaseId	path	True	integer (int32)	ID del lease da aggiornare.
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.

Corpo della richiesta

Nome	Tipo	Descrizione
daysValid	integer (int32)	Numero di giorni da considerare valido per il lease. Un lease di conservazione valido per più di 100 anni (36500 giorni) verrà visualizzato come conservare la compilazione "per sempre".
protectPipeline	boolean	Se impostato, questo lease impedirà anche l'eliminazione della pipeline mentre il lease è ancora valido.

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_execute	Concede la possibilità di accedere agli artefatti di compilazione, inclusi i risultati di compilazione, le definizioni e le richieste e la possibilità di accodare una compilazione, aggiornare le proprietà di compilazione e la possibilità di ricevere notifiche sugli eventi di compilazione tramite hook del servizio.

Definizioni

Nome	Descrizione
RetentionLease	Un lease di conservazione valido impedisce ai sistemi automatizzati di eliminare un'esecuzione della pipeline.
RetentionLeaseUpdate	Aggiornamento dei parametri di conservazione di un lease di conservazione.

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.

RetentionLeaseUpdate