Leases - Add
Добавляет новые аренды для выполнения конвейера.
POST https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?api-version=7.1-preview.2Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Название организации Azure DevOps. |
|
project
|
path | True |
string |
Идентификатор проекта или имя проекта |
|
api-version
|
query | True |
string |
Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.2. |
Текст запроса
| Имя | Тип | Описание |
|---|---|---|
| body |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
успешная операция |
Безопасность
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
| Имя | Описание |
|---|---|
| vso.build_execute | Предоставляет возможность доступа к артефактам сборки, включая результаты сборки, определения и запросы, а также возможность ставить сборку в очередь, обновлять свойства сборки и получать уведомления о событиях сборки с помощью перехватчиков служб. |
Определения
| Имя | Описание |
|---|---|
|
New |
Необходимые сведения для создания новой аренды хранения. |
|
Retention |
Допустимая аренда хранения не позволяет автоматизированным системам удалять запуск конвейера. |
NewRetentionLease
Необходимые сведения для создания новой аренды хранения.
| Имя | Тип | Описание |
|---|---|---|
| daysValid |
integer |
Количество дней, в течение которых аренда считается действительной. Аренда хранения, действительная более 100 лет (36500 дней), будет отображаться как сохранение сборки "навсегда". |
| definitionId |
integer |
Определение конвейера выполнения. |
| ownerId |
string |
Предоставленная пользователем строка, идентифицирующая владельца аренды хранения. |
| protectPipeline |
boolean |
Если этот параметр задан, эта аренда также будет препятствовать удалению конвейера, пока аренда все еще действительна. |
| runId |
integer |
Конвейер выполняется для защиты. |
RetentionLease
Допустимая аренда хранения не позволяет автоматизированным системам удалять запуск конвейера.
| Имя | Тип | Описание |
|---|---|---|
| createdOn |
string |
При создании аренды. |
| definitionId |
integer |
Определение конвейера выполнения. |
| leaseId |
integer |
Уникальный идентификатор для этой аренды. |
| ownerId |
string |
Неуникальный строка, идентифицирующая владельца аренды хранения. |
| protectPipeline |
boolean |
Если этот параметр задан, эта аренда также будет препятствовать удалению конвейера, пока аренда все еще действительна. |
| runId |
integer |
Выполнение конвейера защищено этой арендой. |
| validUntil |
string |
Последний день аренды считается действительным. |