Builds - Queue

Service:

Build

API Version:

5.0

Постановка в очередь сборки

POST https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=5.0

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/build/builds?ignoreWarnings={ignoreWarnings}&checkInTicket={checkInTicket}&sourceBuildId={sourceBuildId}&api-version=5.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
project	path	True	string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 5.0.
checkInTicket	query		string
ignoreWarnings	query		boolean
sourceBuildId	query		integer int32

Текст запроса

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
buildNumber	string	Номер или имя сборки.
buildNumberRevision	integer	Редакция номера сборки.
controller	BuildController	Контроллер сборки. Этот параметр устанавливается только в том случае, если тип определения — Xaml.
definition	DefinitionReference	Определение, связанное со сборкой.
deleted	boolean	Указывает, была ли сборка удалена.
deletedBy	IdentityRef	Удостоверение процесса или пользователя, которые удалили сборку.
deletedDate	string	Дата удаления сборки.
deletedReason	string	Описание удаления сборки.
demands	Demand[]	Список требований, представляющих возможности агента, необходимые для этой сборки.
finishTime	string	Время завершения сборки.
id	integer	Идентификатор сборки.
keepForever	boolean	Указывает, следует ли пропускать сборку политиками хранения.
lastChangedBy	IdentityRef	Удостоверение, представляющее процесс или пользователя, который последний раз изменял сборку.
lastChangedDate	string	Дата последнего изменения сборки.
logs	BuildLogReference	Сведения о журналах сборки.
orchestrationPlan	TaskOrchestrationPlanReference	План оркестрации для сборки.
parameters	string	Параметры для сборки.
plans	TaskOrchestrationPlanReference[]	Планы оркестрации, связанные со сборкой (сборка, очистка)
priority	QueuePriority	Приоритет сборки.
project	TeamProjectReference	Командный проект.
properties	PropertiesCollection	Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с TypeCode != TypeCode.Object), кроме DBNull . Значения типа Byte[], Int32, Double, DateType и String сохраняют свой тип, другие примитивы перенастраиваются как String. Byte[] — строка в кодировке Base64.
quality	string	Качество сборки XAML (хорошее, плохое и т. д.)
queue	AgentPoolQueue	Очередь. Этот параметр устанавливается только в том случае, если тип определения — Build.
queueOptions	QueueOptions	Дополнительные параметры для постановки сборки в очередь.
queuePosition	integer	Текущее положение сборки в очереди.
queueTime	string	Время постановки сборки в очередь.
reason	BuildReason	Причина создания сборки.
repository	BuildRepository	Репозиторий.
requestedBy	IdentityRef	Удостоверение, которое помещалось в очередь сборки.
requestedFor	IdentityRef	Удостоверение, от имени которого сборка была поставлена в очередь.
result	BuildResult	Результат сборки.
retainedByRelease	boolean	Указывает, сохраняется ли сборка в выпуске.
sourceBranch	string	Исходная ветвь.
sourceVersion	string	версия исходных файлов.
startTime	string	Время запуска сборки.
status	BuildStatus	Состояние сборки.
tags	string[]
triggerInfo	object	Сведения, относящиеся к источнику, о том, что вызвало сборку
triggeredByBuild	Build	Сборка, которая активирует эту сборку с помощью триггера завершения сборки.
uri	string	Универсальный код ресурса (URI) сборки.
url	string	URL-адрес REST сборки.
validationResults	BuildRequestValidationResult[]	Представляет результат проверки запроса на сборку.

Ответы

Имя	Тип	Описание
200 OK	Build	успешная операция

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

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

Определения

Имя	Описание
AgentPoolQueue	Представляет очередь для выполнения сборок.
Build	Представление данных сборки.
BuildController
BuildLogReference	Представляет ссылку на журнал сборки.
BuildReason	Причина создания сборки.
BuildRepository	Представляет репозиторий, используемый определением сборки.
BuildRequestValidationResult	Представляет результат проверки запроса на сборку.
BuildResult	Результат сборки.
BuildStatus	Состояние сборки.
ControllerStatus	Состояние контроллера.
DefinitionQueueStatus	Значение типа , указывающее, можно ли поместить сборки в очередь для этого определения.
DefinitionReference	Представляет ссылку на определение.
DefinitionType	Тип определения.
Demand	Представляет запрос, используемый определением или сборкой.
IdentityRef
ProjectState	Состояние проекта.
ProjectVisibility	Видимость проекта.
PropertiesCollection	Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с TypeCode != TypeCode.Object), кроме DBNull . Значения типа Byte[], Int32, Double, DateType и String сохраняют свой тип, другие примитивы перенастраиваются как String. Byte[] — строка в кодировке Base64.
QueueOptions	Дополнительные параметры для постановки сборки в очередь.
QueuePriority	Приоритет сборки.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
TaskAgentPoolReference	Представляет ссылку на пул агентов.
TaskOrchestrationPlanReference	Представляет ссылку на план оркестрации.
TeamProjectReference	Представляет неглубокую ссылку на TeamProject.
ValidationResult	Результат.

AgentPoolQueue

Представляет очередь для выполнения сборок.

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
id	integer	Идентификатор очереди.
name	string	Имя очереди.
pool	TaskAgentPoolReference	Пул, используемый этой очередью.
url	string	Полная http-ссылка на ресурс.

Build

Представление данных сборки.

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
buildNumber	string	Номер или имя сборки.
buildNumberRevision	integer	Редакция номера сборки.
controller	BuildController	Контроллер сборки. Этот параметр устанавливается только в том случае, если тип определения — Xaml.
definition	DefinitionReference	Определение, связанное со сборкой.
deleted	boolean	Указывает, была ли сборка удалена.
deletedBy	IdentityRef	Удостоверение процесса или пользователя, которые удалили сборку.
deletedDate	string	Дата удаления сборки.
deletedReason	string	Описание удаления сборки.
demands	Demand[]	Список требований, представляющих возможности агента, необходимые для этой сборки.
finishTime	string	Время завершения сборки.
id	integer	Идентификатор сборки.
keepForever	boolean	Указывает, следует ли пропускать сборку политиками хранения.
lastChangedBy	IdentityRef	Удостоверение, представляющее процесс или пользователя, который последний раз изменял сборку.
lastChangedDate	string	Дата последнего изменения сборки.
logs	BuildLogReference	Сведения о журналах сборки.
orchestrationPlan	TaskOrchestrationPlanReference	План оркестрации для сборки.
parameters	string	Параметры для сборки.
plans	TaskOrchestrationPlanReference[]	Планы оркестрации, связанные со сборкой (сборка, очистка)
priority	QueuePriority	Приоритет сборки.
project	TeamProjectReference	Командный проект.
properties	PropertiesCollection	Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с TypeCode != TypeCode.Object), кроме DBNull . Значения типа Byte[], Int32, Double, DateType и String сохраняют свой тип, другие примитивы перенастраиваются как String. Byte[] — строка в кодировке Base64.
quality	string	Качество сборки XAML (хорошее, плохое и т. д.)
queue	AgentPoolQueue	Очередь. Этот параметр устанавливается только в том случае, если тип определения — Build.
queueOptions	QueueOptions	Дополнительные параметры для постановки сборки в очередь.
queuePosition	integer	Текущее положение сборки в очереди.
queueTime	string	Время постановки сборки в очередь.
reason	BuildReason	Причина создания сборки.
repository	BuildRepository	Репозиторий.
requestedBy	IdentityRef	Удостоверение, которое помещалось в очередь сборки.
requestedFor	IdentityRef	Удостоверение, от имени которого сборка была поставлена в очередь.
result	BuildResult	Результат сборки.
retainedByRelease	boolean	Указывает, сохраняется ли сборка в выпуске.
sourceBranch	string	Исходная ветвь.
sourceVersion	string	версия исходных файлов.
startTime	string	Время запуска сборки.
status	BuildStatus	Состояние сборки.
tags	string[]
triggerInfo	object	Сведения, относящиеся к источнику, о том, что вызвало сборку
triggeredByBuild	Build	Сборка, которая активирует эту сборку с помощью триггера завершения сборки.
uri	string	Универсальный код ресурса (URI) сборки.
url	string	URL-адрес REST сборки.
validationResults	BuildRequestValidationResult[]	Представляет результат проверки запроса на сборку.

BuildController

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
createdDate	string	Дата создания контроллера.
description	string	Описание контроллера.
enabled	boolean	Указывает, включен ли контроллер.
id	integer	Идентификатор ресурса
name	string	Имя связанного ресурса (имя определения, имя контроллера и т. д.)
status	ControllerStatus	Состояние контроллера.
updatedDate	string	Дата последнего обновления контроллера.
uri	string	Универсальный код ресурса (URI) контроллера.
url	string	Полная ссылка http на ресурс

BuildLogReference

Представляет ссылку на журнал сборки.

Имя	Тип	Описание
id	integer	Идентификатор журнала.
type	string	Тип расположения журнала.
url	string	Полная ссылка на ресурс журнала.

BuildReason

Причина создания сборки.

Имя	Тип	Описание
all	string	Все причины.
batchedCI	string	Сборка была запущена для триггера TriggerType.BatchedContinuousIntegration.
buildCompletion	string	Сборка была запущена после завершения другой сборки.
checkInShelveset	string	Сборка была запущена для триггера ContinuousIntegrationType.Gated.
individualCI	string	Сборка была запущена для триггера TriggerType.ContinuousIntegration.
manual	string	Сборка была запущена вручную.
none	string	Без причины. Это значение не следует использовать.
pullRequest	string	Сборка была запущена запросом на вытягивание. Добавлено в ресурс версии 3.
schedule	string	Сборка была запущена для триггера TriggerType.Schedule.
triggered	string	Сборка была активирована для целей политики хранения.
userCreated	string	Сборка была создана пользователем.
validateShelveset	string	Сборка была запущена вручную для частной проверки.

BuildRepository

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

Имя	Тип	Описание
checkoutSubmodules	boolean	Указывает, следует ли извлечь подмодули.
clean	string	Указывает, следует ли очищать целевую папку при получении кода из репозитория.
defaultBranch	string	Имя ветвь по умолчанию.
id	string	Идентификатор репозитория.
name	string	Понятное имя репозитория.
properties	object
rootFolder	string	Корневая папка.
type	string	Тип репозитория.
url	string	URL-адрес репозитория.

BuildRequestValidationResult

Представляет результат проверки запроса на сборку.

Имя	Тип	Описание
message	string	Сообщение, связанное с результатом.
result	ValidationResult	Результат.

BuildResult

Результат сборки.

Имя	Тип	Описание
canceled	string	Сборка была отменена перед запуском.
failed	string	Сборка завершилась неудачно.
none	string	Нет результата
partiallySucceeded	string	Компиляция успешно завершена, но были и другие ошибки.
succeeded	string	Сборка успешно завершена.

BuildStatus

Состояние сборки.

Имя	Тип	Описание
all	string	Все состояния.
cancelling	string	Сборка отменяется
completed	string	Сборка завершена.
inProgress	string	Сборка в настоящее время выполняется.
none	string	Состояние отсутствует.
notStarted	string	Сборка еще не запущена.
postponed	string	Сборка неактивна в очереди.

ControllerStatus

Состояние контроллера.

Имя	Тип	Описание
available	string	Указывает, что контроллер сборки в настоящее время доступен.
offline	string	Указывает, что контроллер сборки перевел себя в автономный режим.
unavailable	string	Указывает, что невозможно связаться с контроллером сборки.

DefinitionQueueStatus

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

Имя	Тип	Описание
disabled	string	При отключении очередь определений не позволит пользователям помещать сборки в очередь, а система не будет ставить в очередь запланированные, закрытые или непрерывные сборки интеграции. Сборки, которые уже находятся в очереди, не будут запущены системой.
enabled	string	Если очередь определений включена, она позволяет пользователям помещать сборки в очередь, система будет ставить в очередь запланированные сборки, сборки с шлюзом и непрерывной интеграции, а сборки в очереди будут запущены системой.
paused	string	При приостановке очередь определений позволяет пользователям помещать сборки в очередь, а система будет ставить в очередь запланированные, закрытые и непрерывные сборки интеграции. Сборки в очереди не будут запускаться системой.

DefinitionReference

Представляет ссылку на определение.

Имя	Тип	Описание
createdDate	string	Дата создания определения.
id	integer	Идентификатор определения, на который указывает ссылка.
name	string	Имя определения, на который указывает ссылка.
path	string	Путь к папке определения.
project	TeamProjectReference	Ссылка на проект.
queueStatus	DefinitionQueueStatus	Значение типа , указывающее, можно ли поместить сборки в очередь для этого определения.
revision	integer	Номер редакции определения.
type	DefinitionType	Тип определения.
uri	string	Универсальный код ресурса (URI) определения.
url	string	URL-адрес REST определения.

DefinitionType

Тип определения.

Имя	Тип	Описание
build	string
xaml	string

Demand

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

Имя	Тип	Описание
name	string	Имя возможности, на которую ссылается запрос.
value	string	Необходимое значение.

IdentityRef

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string
displayName	string	Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Этот URL-адрес является полным маршрутом к исходному ресурсу этого субъекта графа.

ProjectState

Состояние проекта.

Имя	Тип	Описание
all	string	Все проекты независимо от состояния.
createPending	string	Проект поставлен в очередь для создания, но процесс еще не запущен.
deleted	string	Проект удален.
deleting	string	Проект находится в процессе удаления.
new	string	Проект находится в процессе создания.
unchanged	string	Проект не был изменен.
wellFormed	string	Проект полностью создан и готов к использованию.

ProjectVisibility

Видимость проекта.

Имя	Тип	Описание
private	string	Проект виден только пользователям с явным доступом.
public	string	Проект виден всем.

PropertiesCollection

Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любого типа с TypeCode != TypeCode.Object), кроме DBNull . Значения типа Byte[], Int32, Double, DateType и String сохраняют свой тип, другие примитивы перенастраиваются как String. Byte[] — строка в кодировке Base64.

Имя	Тип	Описание
count	integer	Количество свойств в коллекции.
item	object
keys	string[]	Набор ключей в коллекции.
values	string[]	Набор значений в коллекции.

QueueOptions

Дополнительные параметры для постановки сборки в очередь.

Имя	Тип	Описание
doNotRun	string	Создайте идентификатор плана для сборки, не запускайте ее
none	string	Нет параметров очереди

QueuePriority

Приоритет сборки.

Имя	Тип	Описание
aboveNormal	string	Выше нормального приоритета.
belowNormal	string	Ниже нормального приоритета.
high	string	Высокий приоритет.
low	string	Низкий приоритет.
normal	string	Обычный приоритет.

ReferenceLinks

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

TaskAgentPoolReference

Представляет ссылку на пул агентов.

Имя	Тип	Описание
id	integer	Идентификатор пула.
isHosted	boolean	Значение, указывающее, управляется ли этот пул службой.
name	string	Имя пула.

TaskOrchestrationPlanReference

Представляет ссылку на план оркестрации.

Имя	Тип	Описание
orchestrationType	integer	Тип плана.
planId	string	Идентификатор плана.

TeamProjectReference

Представляет неглубокую ссылку на TeamProject.

Имя	Тип	Описание
abbreviation	string	Сокращение проекта.
defaultTeamImageUrl	string	URL-адрес образа удостоверения команды по умолчанию.
description	string	Описание проекта (при наличии).
id	string	Идентификатор проекта.
name	string	Имя проекта.
revision	integer	Редакция проекта.
state	ProjectState	Состояние проекта.
url	string	URL-адрес полной версии объекта.
visibility	ProjectVisibility	Видимость проекта.

ValidationResult

Результат.

Имя	Тип	Описание
error	string
oK	string
warning	string