Leases - Add

Usługa:

Build

Wersja interfejsu API:

7.1

Dodaje nowe dzierżawy dla przebiegów potoku.

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

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. Należy ustawić wartość "7.1", 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

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

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 dotyczące tworzenia nowej dzierżawy przechowywania.
RetentionLease	Prawidłowa dzierżawa przechowywania uniemożliwia automatyczne systemy usuwania uruchomienia potoku.

NewRetentionLease

Objekt

Wymagane informacje dotyczące tworzenia nowej dzierżawy przechowywania.

Nazwa	Typ	Opis
daysValid	integer (int32)	Liczba dni, przez które należy wziąć pod uwagę prawidłową dzierżawę. Dzierżawa przechowywania ważna przez ponad 100 lat (36500 dni) będzie wyświetlana jako zachowywanie kompilacji "na zawsze".
definitionId	integer (int32)	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 (int32)	Uruchomienie potoku w celu ochrony.

RetentionLease

Objekt

Prawidłowa dzierżawa przechowywania uniemożliwia automatyczne systemy usuwania uruchomienia potoku.

Nazwa	Typ	Opis
createdOn	string (date-time)	Po utworzeniu dzierżawy.
definitionId	integer (int32)	Definicja potoku przebiegu.
leaseId	integer (int32)	Unikatowy identyfikator tej dzierżawy.
ownerId	string	Bez unikatowego ciągu identyfikującego 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 (int32)	Przebieg potoku chroniony przez tę dzierżawę.
validUntil	string (date-time)	Ostatni dzień dzierżawy jest uznawany za prawidłowy.