Builds - Queue

Referencia

Servicio:: Build

Versión de la API:: 7.1

Pone en cola una compilación

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	Nombre de la organización de Azure DevOps.
project	path	True	string	Id. de proyecto o nombre del proyecto
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.1" para usar esta versión de la API.
checkInTicket	query		string
definitionId	query		integer (int32)	Identificador de definición opcional para poner en cola una compilación sin un cuerpo. Se omite si hay un cuerpo válido
ignoreWarnings	query		boolean
sourceBuildId	query		integer (int32)

Cuerpo de la solicitud

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que representa una colección de vínculos de referencia rest.
agentSpecification	AgentSpecification	Especificación del agente para la compilación.
appendCommitMessageToRunName	boolean	Anexar mensaje de confirmación a BuildNumber en la interfaz de usuario.
buildNumber	string	Número o nombre de compilación de la compilación.
buildNumberRevision	integer (int32)	Revisión del número de compilación.
controller	BuildController	Controlador de compilación. Esto solo se establece si el tipo de definición es Xaml.
definition	DefinitionReference	Definición asociada a la compilación.
deleted	boolean	Indica si se ha eliminado la compilación.
deletedBy	IdentityRef	Identidad del proceso o persona que eliminó la compilación.
deletedDate	string (date-time)	Fecha en que se eliminó la compilación.
deletedReason	string	Descripción de cómo se eliminó la compilación.
demands	Demand[]	Una lista de demandas que representa las funcionalidades del agente requeridas por esta compilación.
finishTime	string (date-time)	Hora en que se completó la compilación.
id	integer (int32)	Identificador de la compilación.
lastChangedBy	IdentityRef	Identidad que representa el proceso o la persona que modificó la compilación por última vez.
lastChangedDate	string (date-time)	Fecha en que se cambió la compilación por última vez.
logs	BuildLogReference	Información sobre los registros de compilación.
orchestrationPlan	TaskOrchestrationPlanReference	Plan de orquestación de la compilación.
parameters	string	Parámetros de la compilación.
plans	TaskOrchestrationPlanReference[]	Planes de orquestación asociados a la compilación (compilación, limpieza)
priority	QueuePriority	Prioridad de la compilación.
project	TeamProjectReference	Proyecto de equipo.
properties	PropertiesCollection	La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un `TypeCode != TypeCode.Object`), excepto para `DBNull`. Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.
quality	string	La calidad de la compilación xaml (buena, mala, etc.)
queue	AgentPoolQueue	Cola. Esto solo se establece si el tipo de definición es Build. ADVERTENCIA: este campo está en desuso y no corresponde a las colas de trabajos.
queueOptions	QueueOptions	Opciones adicionales para poner en cola la compilación.
queuePosition	integer (int32)	Posición actual de la compilación en la cola.
queueTime	string (date-time)	Hora en que se puso en cola la compilación.
reason	BuildReason	Motivo por el que se creó la compilación.
repository	BuildRepository	Repositorio.
requestedBy	IdentityRef	Identidad que pone en cola la compilación.
requestedFor	IdentityRef	Identidad en cuyo nombre se puso en cola la compilación.
result	BuildResult	Resultado de la compilación.
retainedByRelease	boolean	Indica si una versión conserva la compilación.
sourceBranch	string	Rama de origen.
sourceVersion	string	Versión de origen.
startTime	string (date-time)	Hora en que se inició la compilación.
status	BuildStatus	Estado de la compilación.
tags	string[]
templateParameters	object	Parámetros para la evaluación de expresiones de plantilla
triggerInfo	object	Información específica de Sourceprovider sobre lo que desencadenó la compilación
triggeredByBuild	Build	Compilación que desencadenó esta compilación a través de un desencadenador de finalización de compilación.
uri	string	Identificador URI de la compilación.
url	string	Dirección URL de REST de la compilación.
validationResults	BuildRequestValidationResult[]	Representa el resultado de validar una solicitud de compilación.

Respuestas

Nombre	Tipo	Description
200 OK	Build	operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del token: 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

Ámbitos

Nombre	Description
vso.build_execute	Concede la capacidad de acceder a los artefactos de compilación, incluidos los resultados de compilación, las definiciones y las solicitudes, y la capacidad de poner en cola una compilación, actualizar las propiedades de compilación y la capacidad de recibir notificaciones sobre eventos de compilación a través de enlaces de servicio.

Definiciones

Nombre	Description
AgentPoolQueue	Representa una cola para ejecutar compilaciones.
AgentSpecification	Especificación del agente definido por el proveedor del grupo.
Build	Representación de datos de una compilación.
BuildController
BuildLogReference	Representa una referencia a un registro de compilación.
BuildReason	Motivo por el que se creó la compilación.
BuildRepository	Representa un repositorio usado por una definición de compilación.
BuildRequestValidationResult	Representa el resultado de validar una solicitud de compilación.
BuildResult	Resultado de la compilación.
BuildStatus	Estado de compilación.
ControllerStatus	Estado del controlador.
DefinitionQueueStatus	Valor que indica si las compilaciones se pueden poner en cola en esta definición.
DefinitionReference	Representa una referencia a una definición.
DefinitionType	Tipo de la definición.
Demand	Representa una demanda usada por una definición o compilación.
IdentityRef
ProjectState	Estado del proyecto.
ProjectVisibility	Visibilidad del proyecto.
PropertiesCollection	La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un `TypeCode != TypeCode.Object`), excepto para `DBNull`. Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.
QueueOptions	Opciones adicionales para poner en cola la compilación.
QueuePriority	Prioridad de la compilación.
ReferenceLinks	Clase que representa una colección de vínculos de referencia rest.
TaskAgentPoolReference	Representa una referencia a un grupo de agentes.
TaskOrchestrationPlanReference	Representa una referencia a un plan de orquestación.
TeamProjectReference	Representa una referencia superficial a un TeamProject.
ValidationResult	Resultado.

AgentPoolQueue

Object

Representa una cola para ejecutar compilaciones.

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que representa una colección de vínculos de referencia rest.
id	integer (int32)	Identificador de la cola.
name	string	Nombre de la cola.
pool	TaskAgentPoolReference	Grupo usado por esta cola.
url	string	Vínculo http completo al recurso.

AgentSpecification

Object

Especificación del agente definido por el proveedor del grupo.

Nombre	Tipo	Description
identifier	string	Identificador único de especificación del agente.

Build

Object

Representación de datos de una compilación.

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que representa una colección de vínculos de referencia rest.
agentSpecification	AgentSpecification	Especificación del agente para la compilación.
appendCommitMessageToRunName	boolean	Anexar mensaje de confirmación a BuildNumber en la interfaz de usuario.
buildNumber	string	Número o nombre de compilación de la compilación.
buildNumberRevision	integer (int32)	Revisión del número de compilación.
controller	BuildController	Controlador de compilación. Esto solo se establece si el tipo de definición es Xaml.
definition	DefinitionReference	Definición asociada a la compilación.
deleted	boolean	Indica si se ha eliminado la compilación.
deletedBy	IdentityRef	Identidad del proceso o persona que eliminó la compilación.
deletedDate	string (date-time)	Fecha en que se eliminó la compilación.
deletedReason	string	Descripción de cómo se eliminó la compilación.
demands	Demand[]	Una lista de demandas que representa las funcionalidades del agente requeridas por esta compilación.
finishTime	string (date-time)	Hora en que se completó la compilación.
id	integer (int32)	Identificador de la compilación.
lastChangedBy	IdentityRef	Identidad que representa el proceso o la persona que modificó la compilación por última vez.
lastChangedDate	string (date-time)	Fecha en que se cambió la compilación por última vez.
logs	BuildLogReference	Información sobre los registros de compilación.
orchestrationPlan	TaskOrchestrationPlanReference	Plan de orquestación de la compilación.
parameters	string	Parámetros de la compilación.
plans	TaskOrchestrationPlanReference[]	Planes de orquestación asociados a la compilación (compilación, limpieza)
priority	QueuePriority	Prioridad de la compilación.
project	TeamProjectReference	Proyecto de equipo.
properties	PropertiesCollection	La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un `TypeCode != TypeCode.Object`), excepto para `DBNull`. Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.
quality	string	La calidad de la compilación xaml (buena, mala, etc.)
queue	AgentPoolQueue	Cola. Esto solo se establece si el tipo de definición es Build. ADVERTENCIA: este campo está en desuso y no corresponde a las colas de trabajos.
queueOptions	QueueOptions	Opciones adicionales para poner en cola la compilación.
queuePosition	integer (int32)	Posición actual de la compilación en la cola.
queueTime	string (date-time)	Hora en que se puso en cola la compilación.
reason	BuildReason	Motivo por el que se creó la compilación.
repository	BuildRepository	Repositorio.
requestedBy	IdentityRef	Identidad que pone en cola la compilación.
requestedFor	IdentityRef	Identidad en cuyo nombre se puso en cola la compilación.
result	BuildResult	Resultado de la compilación.
retainedByRelease	boolean	Indica si una versión conserva la compilación.
sourceBranch	string	Rama de origen.
sourceVersion	string	Versión de origen.
startTime	string (date-time)	Hora en que se inició la compilación.
status	BuildStatus	Estado de la compilación.
tags	string[]
templateParameters	object	Parámetros para la evaluación de expresiones de plantilla
triggerInfo	object	Información específica de Sourceprovider sobre lo que desencadenó la compilación
triggeredByBuild	Build	Compilación que desencadenó esta compilación a través de un desencadenador de finalización de compilación.
uri	string	Identificador URI de la compilación.
url	string	Dirección URL de REST de la compilación.
validationResults	BuildRequestValidationResult[]	Representa el resultado de validar una solicitud de compilación.

BuildController

Object

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que representa una colección de vínculos de referencia rest.
createdDate	string (date-time)	Fecha en que se creó el controlador.
description	string	Descripción del controlador.
enabled	boolean	Indica si el controlador está habilitado.
id	integer (int32)	Identificador del recurso
name	string	Nombre del recurso vinculado (nombre de definición, nombre del controlador, etc.)
status	ControllerStatus	Estado del controlador.
updatedDate	string (date-time)	Fecha en que se actualizó por última vez el controlador.
uri	string	URI del controlador.
url	string	Vínculo http completo al recurso

BuildLogReference

Object

Representa una referencia a un registro de compilación.

Nombre	Tipo	Description
id	integer (int32)	Identificador del registro.
type	string	Tipo de la ubicación del registro.
url	string	Vínculo completo al recurso de registro.

BuildReason

Enumeración

Motivo por el que se creó la compilación.

Valor	Description
all	Todas las razones.
batchedCI	La compilación se inició para el desencadenador TriggerType.BatchedContinuousIntegration.
buildCompletion	La compilación se inició cuando se completó otra compilación.
checkInShelveset	La compilación se inició para el desencadenador ContinuousIntegrationType.Gated.
individualCI	La compilación se inició para el desencadenador TriggerType.ContinuousIntegration.
manual	La compilación se inició manualmente.
none	Por nada. Este valor no se debe usar.
pullRequest	La compilación se inició mediante una solicitud de incorporación de cambios. Se agregó en la versión 3 del recurso.
resourceTrigger	La compilación se inició cuando los recursos de la canalización lo desencadenaron
schedule	La compilación se inició para el desencadenador TriggerType.Schedule.
scheduleForced	La compilación se inició para el desencadenador TriggerType.ScheduleForced.
triggered	La compilación se desencadenó con fines de directiva de retención.
userCreated	Un usuario creó la compilación.
validateShelveset	La compilación se inició manualmente para la validación privada.

BuildRepository

Object

Representa un repositorio usado por una definición de compilación.

Nombre	Tipo	Description
checkoutSubmodules	boolean	Indica si se van a desproteger submódulos.
clean	string	Indica si se debe limpiar la carpeta de destino al obtener código del repositorio.
defaultBranch	string	Nombre de la rama predeterminada.
id	string	Identificador del repositorio.
name	string	Nombre descriptivo del repositorio.
properties	object
rootFolder	string	Carpeta raíz.
type	string	Tipo del repositorio.
url	string	Dirección URL del repositorio.

BuildRequestValidationResult

Object

Representa el resultado de validar una solicitud de compilación.

Nombre	Tipo	Description
message	string	Mensaje asociado al resultado.
result	ValidationResult	Resultado.

BuildResult

Enumeración

Resultado de la compilación.

Valor	Description
canceled	La compilación se canceló antes de comenzar.
failed	La compilación se completó sin éxito.
none	Sin resultado
partiallySucceeded	La compilación completó correctamente la compilación, pero tenía otros errores.
succeeded	La compilación se completó correctamente.

BuildStatus

Enumeración

Estado de compilación.

Valor	Description
all	Todo el estado.
cancelling	La compilación está cancelando
completed	La compilación se ha completado.
inProgress	La compilación está actualmente en curso.
none	Sin estado.
notStarted	La compilación aún no se ha iniciado.
postponed	La compilación está inactiva en la cola.

ControllerStatus

Enumeración

Estado del controlador.

Valor	Description
available	Indica que el controlador de compilación está disponible actualmente.
offline	Indica que el controlador de compilación se ha desconectado.
unavailable	Indica que no se puede ponerse en contacto con el controlador de compilación.

DefinitionQueueStatus

Enumeración

Valor que indica si las compilaciones se pueden poner en cola en esta definición.

Valor	Description
disabled	Cuando se deshabilita la cola de definiciones, los usuarios no permitirán poner en cola las compilaciones y el sistema no pondrá en cola compilaciones programadas, controladas o de integración continua. El sistema no iniciará las compilaciones ya en la cola.
enabled	Cuando se habilita la cola de definiciones permite poner en cola las compilaciones por parte de los usuarios, el sistema pondrá en cola compilaciones programadas, controladas y de integración continua, y el sistema iniciará las compilaciones en cola.
paused	Cuando se pausa la cola de definiciones, los usuarios ponen en cola las compilaciones y el sistema pondrá en cola compilaciones programadas, controladas y de integración continua. El sistema no iniciará compilaciones en la cola.

DefinitionReference

Object

Representa una referencia a una definición.

Nombre	Tipo	Description
createdDate	string (date-time)	Fecha en que se creó esta versión de la definición.
id	integer (int32)	Identificador de la definición a la que se hace referencia.
name	string	Nombre de la definición a la que se hace referencia.
path	string	Ruta de acceso de la carpeta de la definición.
project	TeamProjectReference	Referencia al proyecto.
queueStatus	DefinitionQueueStatus	Valor que indica si las compilaciones se pueden poner en cola en esta definición.
revision	integer (int32)	Número de revisión de definición.
type	DefinitionType	Tipo de la definición.
uri	string	URI de la definición.
url	string	Dirección URL de REST de la definición.

DefinitionType

Enumeración

Tipo de la definición.

Valor	Description
build
xaml

Demand

Object

Representa una demanda usada por una definición o compilación.

Nombre	Tipo	Description
name	string	Nombre de la funcionalidad a la que hace referencia la demanda.
value	string	Valor solicitado.

IdentityRef

Object

Nombre	Tipo	Description
_links	ReferenceLinks	Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo.
descriptor	string	El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones.
directoryAlias	string	En desuso: se puede recuperar consultando al usuario de Graph al que se hace referencia en la entrada "self" del diccionario identityRef "_links".
displayName	string	Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen.
id	string
imageUrl	string	En desuso: disponible en la entrada "avatar" del diccionario "_links" identityRef
inactive	boolean	En desuso: se puede recuperar consultando el estado de pertenencia de Graph al que se hace referencia en la entrada "membershipState" del diccionario "_links" de GraphUser.
isAadIdentity	boolean	En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	En desuso: no en uso en la mayoría de las implementaciones preexistentes de ToIdentityRef
uniqueName	string	En desuso: use Domain+PrincipalName en su lugar.
url	string	Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

ProjectState

Enumeración

Estado del proyecto.

Valor	Description
all	Todos los proyectos, independientemente del estado, excepto Eliminado.
createPending	Project se ha puesto en cola para su creación, pero el proceso aún no se ha iniciado.
deleted	Se ha eliminado el proyecto.
deleting	Project está en proceso de eliminación.
new	Project está en proceso de creación.
unchanged	El proyecto no se ha cambiado.
wellFormed	Project se crea completamente y está listo para usarse.

ProjectVisibility

Enumeración

Visibilidad del proyecto.

Valor	Description
private	El proyecto solo es visible para los usuarios con acceso explícito.
public	El proyecto es visible para todos.

PropertiesCollection

Object

La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un TypeCode != TypeCode.Object), excepto para DBNull. Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.

Nombre	Tipo	Description
count	integer (int32)	Recuento de propiedades de la colección.
item	object
keys	string[]	Conjunto de claves de la colección.
values	string[]	Conjunto de valores de la colección.

QueueOptions

Enumeración

Opciones adicionales para poner en cola la compilación.

Valor	Description
doNotRun	Crear un identificador de plan para la compilación, no ejecutarlo
none	Sin opciones de cola

QueuePriority

Enumeración

Prioridad de la compilación.

Valor	Description
aboveNormal	Prioridad normal superior.
belowNormal	Por debajo de la prioridad normal.
high	Prioridad alta.
low	Prioridad baja.
normal	Prioridad normal.

ReferenceLinks

Object

Clase que representa una colección de vínculos de referencia rest.

Nombre	Tipo	Description
links	object	Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

TaskAgentPoolReference

Object

Representa una referencia a un grupo de agentes.

Nombre	Tipo	Description
id	integer (int32)	Identificador del grupo.
isHosted	boolean	Valor que indica si el servicio administra o no este grupo.
name	string	Nombre del grupo.

TaskOrchestrationPlanReference

Object

Representa una referencia a un plan de orquestación.

Nombre	Tipo	Description
orchestrationType	integer (int32)	Tipo del plan.
planId	string (uuid)	Identificador del plan.

TeamProjectReference

Object

Representa una referencia superficial a un TeamProject.

Nombre	Tipo	Description
abbreviation	string	Abreviatura del proyecto.
defaultTeamImageUrl	string	Dirección URL a la imagen de identidad del equipo predeterminada.
description	string	Descripción del proyecto (si existe).
id	string (uuid)	Identificador del proyecto.
lastUpdateTime	string (date-time)	Hora de última actualización del proyecto.
name	string	Nombre del proyecto.
revision	integer (int64)	Revisión del proyecto.
state	ProjectState	Estado del proyecto.
url	string	Dirección URL a la versión completa del objeto.
visibility	ProjectVisibility	Visibilidad del proyecto.

ValidationResult

Enumeración

Resultado.

Valor	Description
error
ok
warning

Compartir a través de

Builds - Queue

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

oauth2

Ámbitos

Definiciones

AgentPoolQueue

AgentSpecification

Build

BuildController

BuildLogReference

BuildReason

BuildRepository

BuildRequestValidationResult

BuildResult

BuildStatus

ControllerStatus

DefinitionQueueStatus

DefinitionReference

DefinitionType

Demand

IdentityRef

ProjectState

ProjectVisibility

PropertiesCollection

QueueOptions

QueuePriority

ReferenceLinks

TaskAgentPoolReference

TaskOrchestrationPlanReference

TeamProjectReference

ValidationResult