Builds - Queue

Служба:

Build

Версия API:

7.1

Очереди сборки

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

С использованием необязательных параметров:

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

Параметры URI

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

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

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

Ответы

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

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

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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

Области

Имя	Описание
vso.build_execute	Предоставляет возможность доступа к артефактам сборки, включая результаты сборки, определения и запросы, а также возможность очереди сборки, обновления свойств сборки и возможность получать уведомления о событиях сборки с помощью перехватчиков служб.

Определения

Имя	Описание
AgentPoolQueue	Представляет очередь для выполнения сборок.
AgentSpecification	Спецификация агента, определенного поставщиком пула.
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 сохраняют их тип, другие примитивы повторно настраиваются в виде строки. Byte[] ожидается как строка в кодировке Base64.
QueueOptions	Дополнительные параметры для очереди сборки.
QueuePriority	Приоритет сборки.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
TaskAgentPoolReference	Представляет ссылку на пул агентов.
TaskOrchestrationPlanReference	Представляет ссылку на план оркестрации.
TeamProjectReference	Представляет неглубокую ссылку на TeamProject.
ValidationResult	Результат.

AgentPoolQueue

Object

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

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

AgentSpecification

Object

Спецификация агента, определенного поставщиком пула.

Имя	Тип	Описание
identifier	string	Уникальный идентификатор спецификации агента.

Build

Object

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

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

BuildController

Object

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

BuildLogReference

Object

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

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

BuildReason

Перечисление

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

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

BuildRepository

Object

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

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

BuildRequestValidationResult

Object

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

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

BuildResult

Перечисление

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

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

BuildStatus

Перечисление

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

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

ControllerStatus

Перечисление

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

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

DefinitionQueueStatus

Перечисление

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

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

DefinitionReference

Object

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

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

DefinitionType

Перечисление

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

Значение	Описание
build
xaml

Demand

Object

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

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

IdentityRef

Object

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит нулевые или более интересные ссылки на тему графа. Эти ссылки могут вызываться для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на тему графа во время выполнения системы. Это поле однозначно определяет одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string	Нерекомендуемое. Можно получить, запросив пользователя Graph, на который ссылается пользователь Graph в записи "self" словаря IdentityRef "_links"
displayName	string	Это не уникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в исходном поставщике.
id	string
imageUrl	string	Не рекомендуется . Доступно в записи "аватар" словаря IdentityRef "_links"
inactive	boolean	Нерекомендуемый — можно получить, запросив состояние членства Graph, на которое ссылается запись "membershipState" словаря GraphUser "_links"
isAadIdentity	boolean	Нерекомендуемый — можно выводить из типа субъекта дескриптора (descriptor.IsAadUserType/descriptor.IsAadGroupType)
isContainer	boolean	Нерекомендуемый — можно выводить из типа субъекта дескриптора (descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Не рекомендуется — не используется в большинстве стандартных реализаций ToIdentityRef
uniqueName	string	Не рекомендуется — вместо этого используйте domain+PrincipalName
url	string	Этот URL-адрес является полным маршрутом к исходному ресурсу данного субъекта графа.

ProjectState

Перечисление

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

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

ProjectVisibility

Перечисление

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

Значение	Описание
private	Проект отображается только пользователям с явным доступом.
public	Проект виден всем.

PropertiesCollection

Object

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

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

QueueOptions

Перечисление

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

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

QueuePriority

Перечисление

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

Значение	Описание
aboveNormal	Выше обычного приоритета.
belowNormal	Ниже обычного приоритета.
high	Высокий приоритет.
low	Низкий приоритет.
normal	Обычный приоритет.

ReferenceLinks

Object

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

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

TaskAgentPoolReference

Object

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

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

TaskOrchestrationPlanReference

Object

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

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

TeamProjectReference

Object

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

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

ValidationResult

Перечисление

Результат.

Значение	Описание
error
ok
warning