Leases - Add

Service:

Build

API Version:

7.1-preview.2

Dodaje nowe dzierżawy dla przebiegów potoków.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wartość powinna mieć wartość "7.1-preview.2", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
body	NewRetentionLease[]

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RetentionLease[]	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.build_execute	Umożliwia dostęp do artefaktów kompilacji, w tym wyników kompilacji, definicji i żądań oraz możliwość kolejkowania kompilacji, aktualizowania właściwości kompilacji oraz odbierania powiadomień o zdarzeniach kompilacji za pośrednictwem punktów zaczepienia usługi.

Definicje

Nazwa	Opis
NewRetentionLease	Wymagane informacje do utworzenia nowej dzierżawy przechowywania.
RetentionLease	Prawidłowa dzierżawa przechowywania uniemożliwia automatycznym systemom usuwanie uruchomienia potoku.

NewRetentionLease

Wymagane informacje do utworzenia nowej dzierżawy przechowywania.

Nazwa	Typ	Opis
daysValid	integer	Liczba dni, przez które należy wziąć pod uwagę ważną dzierżawę. Dzierżawa przechowywania ważna przez ponad 100 lat (36500 dni) będzie wyświetlana jako przechowywanie kompilacji "na zawsze".
definitionId	integer	Definicja potoku przebiegu.
ownerId	string	Ciąg podany przez użytkownika, który identyfikuje właściciela dzierżawy przechowywania.
protectPipeline	boolean	Jeśli ta dzierżawa zostanie ustawiona, uniemożliwi również usunięcie potoku, gdy dzierżawa jest nadal prawidłowa.
runId	integer	Uruchomienie potoku w celu ochrony.

RetentionLease

Prawidłowa dzierżawa przechowywania uniemożliwia automatycznym systemom usuwanie uruchomienia potoku.

Nazwa	Typ	Opis
createdOn	string	Po utworzeniu dzierżawy.
definitionId	integer	Definicja potoku przebiegu.
leaseId	integer	Unikatowy identyfikator tej dzierżawy.
ownerId	string	Ciąg inny niż unikatowy, który identyfikuje właściciela dzierżawy przechowywania.
protectPipeline	boolean	Jeśli ta dzierżawa zostanie ustawiona, uniemożliwi również usunięcie potoku, gdy dzierżawa jest nadal prawidłowa.
runId	integer	Uruchomienie potoku chronionego przez tę dzierżawę.
validUntil	string	Ostatni dzień dzierżawy jest uznawany za prawidłowy.