Builds - Queue

Service:

Build

API Version:

7.1-preview.7

Pone en cola una compilación

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

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	El 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-preview.7" 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 de 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 de compilación o nombre de la compilación.
buildNumberRevision	integer	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	Fecha en que se eliminó la compilación.
deletedReason	string	Descripción de cómo se eliminó la compilación.
demands	Demand[]	Lista de demandas que representa las funcionalidades del agente requeridas por esta compilación.
finishTime	string	Hora a la que se completó la compilación.
id	integer	Identificador de la compilación.
lastChangedBy	IdentityRef	Identidad que representa el proceso o la persona que cambió por última vez la compilación.
lastChangedDate	string	Fecha en la que se cambió por última vez la compilación.
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	El 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 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	Posición actual de la compilación en la cola.
queueTime	string	Hora a la 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	Hora a la 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 del proveedor de origen sobre lo que desencadenó la compilación
triggeredByBuild	Build	La compilación que desencadenó esta compilación a través de un desencadenador de finalización de compilación.
uri	string	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

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

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 utilizado 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	El tipo de la definición.
Demand	Representa una demanda utilizada 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 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 de 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

Representa una cola para ejecutar compilaciones.

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

AgentSpecification

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

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

Build

Representación de datos de una compilación.

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que representa una colección de vínculos de referencia de 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 de compilación o nombre de la compilación.
buildNumberRevision	integer	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	Fecha en que se eliminó la compilación.
deletedReason	string	Descripción de cómo se eliminó la compilación.
demands	Demand[]	Lista de demandas que representa las funcionalidades del agente requeridas por esta compilación.
finishTime	string	Hora en que se completó la compilación.
id	integer	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	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 ) TypeCode != TypeCode.Objectexcepto .DBNull Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como una cadena. 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	Posición actual de la compilación en la cola.
queueTime	string	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	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 del proveedor de origen sobre lo que desencadenó la compilación
triggeredByBuild	Build	Compilación que desencadenó esta compilación mediante 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

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

BuildLogReference

Representa una referencia a un registro de compilación.

Nombre	Tipo	Description
id	integer	Identificador del registro.
type	string	Tipo de la ubicación del registro.
url	string	Un vínculo completo al recurso de registro.

BuildReason

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

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

BuildRepository

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

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

BuildRequestValidationResult

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

Nombre	Tipo	Description
message	string	El mensaje asociado con el resultado.
result	ValidationResult	Resultado.

BuildResult

Resultado de la compilación.

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

BuildStatus

Estado de compilación.

Nombre	Tipo	Description
all	string	Todo el estado.
cancelling	string	La compilación se cancela
completed	string	La compilación se ha completado.
inProgress	string	La compilación está actualmente en curso.
none	string	Ningún estado.
notStarted	string	La compilación aún no se ha iniciado.
postponed	string	La compilación está inactiva en la cola.

ControllerStatus

Estado del controlador.

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

DefinitionQueueStatus

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

Nombre	Tipo	Description
disabled	string	Cuando se deshabilita la cola de definiciones, los usuarios no podrá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	string	Cuando se habilita la cola de definiciones, los usuarios ponen en cola las compilaciones, el sistema pondrá en cola compilaciones programadas, controladas y de integración continua, y el sistema iniciará las compilaciones en cola.
paused	string	Cuando se pone en pausa la cola de definiciones, los usuarios ponen en cola las compilaciones y el sistema se pondrá en cola, programadas, controladas y compilaciones de integración continua. El sistema no iniciará las compilaciones en la cola.

DefinitionReference

Representa una referencia a una definición.

Nombre	Tipo	Description
createdDate	string	Fecha en que se creó esta versión de la definición.
id	integer	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	Número de revisión de definición.
type	DefinitionType	El tipo de la definición.
uri	string	URI de la definición.
url	string	Dirección URL de REST de la definición.

DefinitionType

El tipo de la definición.

Nombre	Tipo	Description
build	string
xaml	string

Demand

Representa una demanda utilizada 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

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 el 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" de 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 GraphUser "_links".
isAadIdentity	boolean	En desuso: se puede deducir del tipo de asunto 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

Estado del proyecto.

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

ProjectVisibility

Visibilidad del proyecto.

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

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 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	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

Opciones adicionales para poner en cola la compilación.

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

QueuePriority

Prioridad de la compilación.

Nombre	Tipo	Description
aboveNormal	string	Por encima de la prioridad normal.
belowNormal	string	Por debajo de la prioridad normal.
high	string	Prioridad alta.
low	string	Prioridad baja.
normal	string	Prioridad normal.

ReferenceLinks

Clase que representa una colección de vínculos de referencia de 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

Representa una referencia a un grupo de agentes.

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

TaskOrchestrationPlanReference

Representa una referencia a un plan de orquestación.

Nombre	Tipo	Description
orchestrationType	integer	Tipo del plan.
planId	string	Identificador del plan.

TeamProjectReference

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	Identificador del proyecto.
lastUpdateTime	string	Hora de la última actualización del proyecto.
name	string	Nombre del proyecto.
revision	integer	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

Resultado.

Nombre	Tipo	Description
error	string
ok	string
warning	string