Поделиться через

Leases - Get Retention Leases By User Id

  • Ссылка
Service:
Build
API Version:
7.1-preview.2

Возвращает все аренды, принадлежащие указанному пользователю, при необходимости в пределах одного определения и выполнения конвейера.

GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?userOwnerId={userOwnerId}&api-version=7.1-preview.2
With optional parameters: 
GET https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?userOwnerId={userOwnerId}&definitionId={definitionId}&runId={runId}&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.
userOwnerId
 query True

string

uuid

Идентификатор пользователя для поиска.
definitionId
 query

integer

int32

Необязательный параметр, ограничивающий поиск определенным определением конвейера.
runId
 query

integer

int32

Необязательный параметр, ограничивающий поиск одним запуском конвейера. Требуется definitionId.

Ответы

Имя Тип Описание
200 OK

RetentionLease[]

успешная операция

Безопасность

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 Предоставляет возможность доступа к артефактам сборки, включая результаты сборки, определения и запросы, а также возможность получать уведомления о событиях сборки с помощью перехватчиков служб.

Определения

RetentionLease

Допустимая аренда хранения не позволяет автоматизированным системам удалять запуск конвейера.

Имя Тип Описание
createdOn

string

При создании аренды.
definitionId

integer

Определение конвейера выполнения.
leaseId

integer

Уникальный идентификатор для этой аренды.
ownerId

string

Неуникальный строка, идентифицирующая владельца аренды хранения.
protectPipeline

boolean

Если этот параметр задан, эта аренда также будет препятствовать удалению конвейера, пока аренда все еще действительна.
runId

integer

Выполнение конвейера защищено этой арендой.
validUntil

string

Последний день аренды считается действительным.