Builds - Queue

Référence

Service:: Build

Version d'API:: 7.1

Met en file d’attente une build

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path	True	string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1 » pour utiliser cette version de l’API.
checkInTicket	query		string
definitionId	query		integer (int32)	ID de définition facultatif pour mettre en file d’attente une build sans corps. Ignoré s’il existe un corps valide
ignoreWarnings	query		boolean
sourceBuildId	query		integer (int32)

Corps de la demande

Nom	Type	Description
_links	ReferenceLinks	Classe à représenter une collection de liens de référence REST.
agentSpecification	AgentSpecification	Spécification de l’agent pour la build.
appendCommitMessageToRunName	boolean	Ajoutez le message de validation à BuildNumber dans l’interface utilisateur.
buildNumber	string	Numéro de build/nom de la build.
buildNumberRevision	integer (int32)	Révision du numéro de build.
controller	BuildController	Contrôleur de build. Cette valeur est définie uniquement si le type de définition est Xaml.
definition	DefinitionReference	Définition associée à la build.
deleted	boolean	Indique si la build a été supprimée.
deletedBy	IdentityRef	Identité du processus ou de la personne qui a supprimé la build.
deletedDate	string (date-time)	Date de suppression de la build.
deletedReason	string	Description de la façon dont la build a été supprimée.
demands	Demand[]	Liste des demandes qui représentent les fonctionnalités de l’agent requises par cette build.
finishTime	string (date-time)	Heure à laquelle la build a été terminée.
id	integer (int32)	ID de la build.
lastChangedBy	IdentityRef	Identité représentant le processus ou la personne qui a modifié la dernière génération.
lastChangedDate	string (date-time)	Date de dernière modification de la build.
logs	BuildLogReference	Informations sur les journaux de génération.
orchestrationPlan	TaskOrchestrationPlanReference	Plan d’orchestration pour la build.
parameters	string	Paramètres de la build.
plans	TaskOrchestrationPlanReference[]	Plans d’orchestration associés à la build (build, nettoyage)
priority	QueuePriority	Priorité de la build.
project	TeamProjectReference	Projet d’équipe.
properties	PropertiesCollection	La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (n’importe quel type avec un `TypeCode != TypeCode.Object`) à l’exception de `DBNull` sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type, d’autres primitives sont retunées sous forme de chaîne. Byte[] attendu comme chaîne encodée en base64.
quality	string	Qualité de la build xaml (bonne, mauvaise, etc.)
queue	AgentPoolQueue	File d’attente. Cette valeur est définie uniquement si le type de définition est Build. AVERTISSEMENT : ce champ est déconseillé et ne correspond pas aux files d’attente des travaux.
queueOptions	QueueOptions	Options supplémentaires pour mettre en file d’attente la build.
queuePosition	integer (int32)	Position actuelle de la build dans la file d’attente.
queueTime	string (date-time)	Heure à laquelle la build a été mise en file d’attente.
reason	BuildReason	Raison pour laquelle la build a été créée.
repository	BuildRepository	Référentiel.
requestedBy	IdentityRef	Identité qui a mis en file d’attente la build.
requestedFor	IdentityRef	Identité au nom de laquelle la build a été mise en file d’attente.
result	BuildResult	Résultat de la génération.
retainedByRelease	boolean	Indique si la build est conservée par une version.
sourceBranch	string	Branche source.
sourceVersion	string	Version source.
startTime	string (date-time)	Heure de démarrage de la build.
status	BuildStatus	État de la build.
tags	string[]
templateParameters	object	Paramètres pour l’évaluation d’expression de modèle
triggerInfo	object	Informations spécifiques à la source concernant ce qui a déclenché la build
triggeredByBuild	Build	Build qui a déclenché cette build via un déclencheur d’achèvement de build.
uri	string	URI de la build.
url	string	URL REST de la build.
validationResults	BuildRequestValidationResult[]	Représente le résultat de la validation d’une demande de build.

Réponses

Nom	Type	Description
200 OK	Build	opération réussie

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

Nom	Description
vso.build_execute	Accorde la possibilité d’accéder aux artefacts de build, notamment les résultats de build, les définitions et les demandes, ainsi que la possibilité de mettre en file d’attente une build, de mettre à jour les propriétés de build et de recevoir des notifications sur les événements de génération via des hooks de service.

Définitions

Nom	Description
AgentPoolQueue	Représente une file d’attente pour les builds en cours d’exécution.
AgentSpecification	Spécification de l’agent défini par le fournisseur de pool.
Build	Représentation des données d’une build.
BuildController
BuildLogReference	Représente une référence à un journal de génération.
BuildReason	Raison pour laquelle la build a été créée.
BuildRepository	Représente un référentiel utilisé par une définition de build.
BuildRequestValidationResult	Représente le résultat de la validation d’une demande de build.
BuildResult	Résultat de la génération.
BuildStatus	État de la build.
ControllerStatus	État du contrôleur.
DefinitionQueueStatus	Valeur qui indique si les builds peuvent être mises en file d’attente sur cette définition.
DefinitionReference	Représente une référence à une définition.
DefinitionType	Type de la définition.
Demand	Représente une demande utilisée par une définition ou une build.
IdentityRef
ProjectState	État du projet.
ProjectVisibility	Visibilité du projet.
PropertiesCollection	La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (n’importe quel type avec un `TypeCode != TypeCode.Object`) à l’exception de `DBNull` sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type, d’autres primitives sont retunées sous forme de chaîne. Byte[] attendu comme chaîne encodée en base64.
QueueOptions	Options supplémentaires pour mettre en file d’attente la build.
QueuePriority	Priorité de la build.
ReferenceLinks	Classe à représenter une collection de liens de référence REST.
TaskAgentPoolReference	Représente une référence à un pool d’agents.
TaskOrchestrationPlanReference	Représente une référence à un plan d’orchestration.
TeamProjectReference	Représente une référence superficielle à un TeamProject.
ValidationResult	Résultat.

AgentPoolQueue

Object

Représente une file d’attente pour les builds en cours d’exécution.

Nom	Type	Description
_links	ReferenceLinks	Classe à représenter une collection de liens de référence REST.
id	integer (int32)	ID de la file d’attente.
name	string	Nom de la file d’attente.
pool	TaskAgentPoolReference	Pool utilisé par cette file d’attente.
url	string	Lien http complet vers la ressource.

AgentSpecification

Object

Spécification de l’agent défini par le fournisseur de pool.

Nom	Type	Description
identifier	string	Identificateur unique de spécification de l’agent.

Build

Object

Représentation des données d’une build.

Nom	Type	Description
_links	ReferenceLinks	Classe à représenter une collection de liens de référence REST.
agentSpecification	AgentSpecification	Spécification de l’agent pour la build.
appendCommitMessageToRunName	boolean	Ajoutez le message de validation à BuildNumber dans l’interface utilisateur.
buildNumber	string	Numéro de build/nom de la build.
buildNumberRevision	integer (int32)	Révision du numéro de build.
controller	BuildController	Contrôleur de build. Cette valeur est définie uniquement si le type de définition est Xaml.
definition	DefinitionReference	Définition associée à la build.
deleted	boolean	Indique si la build a été supprimée.
deletedBy	IdentityRef	Identité du processus ou de la personne qui a supprimé la build.
deletedDate	string (date-time)	Date de suppression de la build.
deletedReason	string	Description de la façon dont la build a été supprimée.
demands	Demand[]	Liste des demandes qui représentent les fonctionnalités de l’agent requises par cette build.
finishTime	string (date-time)	Heure à laquelle la build a été terminée.
id	integer (int32)	ID de la build.
lastChangedBy	IdentityRef	Identité représentant le processus ou la personne qui a modifié la dernière génération.
lastChangedDate	string (date-time)	Date de dernière modification de la build.
logs	BuildLogReference	Informations sur les journaux de génération.
orchestrationPlan	TaskOrchestrationPlanReference	Plan d’orchestration pour la build.
parameters	string	Paramètres de la build.
plans	TaskOrchestrationPlanReference[]	Plans d’orchestration associés à la build (build, nettoyage)
priority	QueuePriority	Priorité de la build.
project	TeamProjectReference	Projet d’équipe.
properties	PropertiesCollection	La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (n’importe quel type avec un `TypeCode != TypeCode.Object`) à l’exception de `DBNull` sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type, d’autres primitives sont retunées sous forme de chaîne. Byte[] attendu comme chaîne encodée en base64.
quality	string	Qualité de la build xaml (bonne, mauvaise, etc.)
queue	AgentPoolQueue	File d’attente. Cette valeur est définie uniquement si le type de définition est Build. AVERTISSEMENT : ce champ est déconseillé et ne correspond pas aux files d’attente des travaux.
queueOptions	QueueOptions	Options supplémentaires pour mettre en file d’attente la build.
queuePosition	integer (int32)	Position actuelle de la build dans la file d’attente.
queueTime	string (date-time)	Heure à laquelle la build a été mise en file d’attente.
reason	BuildReason	Raison pour laquelle la build a été créée.
repository	BuildRepository	Référentiel.
requestedBy	IdentityRef	Identité qui a mis en file d’attente la build.
requestedFor	IdentityRef	Identité au nom de laquelle la build a été mise en file d’attente.
result	BuildResult	Résultat de la génération.
retainedByRelease	boolean	Indique si la build est conservée par une version.
sourceBranch	string	Branche source.
sourceVersion	string	Version source.
startTime	string (date-time)	Heure de démarrage de la build.
status	BuildStatus	État de la build.
tags	string[]
templateParameters	object	Paramètres pour l’évaluation d’expression de modèle
triggerInfo	object	Informations spécifiques à la source concernant ce qui a déclenché la build
triggeredByBuild	Build	Build qui a déclenché cette build via un déclencheur d’achèvement de build.
uri	string	URI de la build.
url	string	URL REST de la build.
validationResults	BuildRequestValidationResult[]	Représente le résultat de la validation d’une demande de build.

BuildController

Object

Nom	Type	Description
_links	ReferenceLinks	Classe à représenter une collection de liens de référence REST.
createdDate	string (date-time)	Date de création du contrôleur.
description	string	Description du contrôleur.
enabled	boolean	Indique si le contrôleur est activé.
id	integer (int32)	ID de la ressource
name	string	Nom de la ressource liée (nom de la définition, nom du contrôleur, etc.)
status	ControllerStatus	État du contrôleur.
updatedDate	string (date-time)	Date de la dernière mise à jour du contrôleur.
uri	string	URI du contrôleur.
url	string	Lien http complet vers la ressource

BuildLogReference

Object

Représente une référence à un journal de génération.

Nom	Type	Description
id	integer (int32)	ID du journal.
type	string	Type de l’emplacement du journal.
url	string	Lien complet vers la ressource de journal.

BuildReason

Énumération

Raison pour laquelle la build a été créée.

Valeur	Description
all	Toutes les raisons.
batchedCI	La build a été démarrée pour le déclencheur TriggerType.BatchedContinuousIntegration.
buildCompletion	La build a été démarrée lors de la fin d’une autre build.
checkInShelveset	La build a été démarrée pour le déclencheur ContinuousIntegrationType.Gated.
individualCI	La build a été démarrée pour le déclencheur TriggerType.ContinuousIntegration.
manual	La build a été démarrée manuellement.
none	Aucune raison. Cette valeur ne doit pas être utilisée.
pullRequest	La build a été démarrée par une demande de tirage. Ajouté dans la version 3 de la ressource.
resourceTrigger	La build a été démarrée lorsque des ressources dans le pipeline l’ont déclenchée
schedule	La build a été démarrée pour le déclencheur TriggerType.Schedule.
scheduleForced	La build a été démarrée pour le déclencheur TriggerType.ScheduleForced.
triggered	La build a été déclenchée à des fins de stratégie de rétention.
userCreated	La build a été créée par un utilisateur.
validateShelveset	La build a été démarrée manuellement pour la validation privée.

BuildRepository

Object

Représente un référentiel utilisé par une définition de build.

Nom	Type	Description
checkoutSubmodules	boolean	Indique s’il faut extraire les sous-modules.
clean	string	Indique s’il faut nettoyer le dossier cible lors de l’obtention du code à partir du référentiel.
defaultBranch	string	Nom de la branche par défaut.
id	string	ID du référentiel.
name	string	Nom convivial du référentiel.
properties	object
rootFolder	string	Dossier racine.
type	string	Type du référentiel.
url	string	URL du référentiel.

BuildRequestValidationResult

Object

Représente le résultat de la validation d’une demande de build.

Nom	Type	Description
message	string	Message associé au résultat.
result	ValidationResult	Résultat.

BuildResult

Énumération

Résultat de la génération.

Valeur	Description
canceled	La build a été annulée avant de commencer.
failed	La build s’est terminée sans succès.
none	Aucun résultat
partiallySucceeded	La compilation a terminé la compilation avec succès, mais elle a rencontré d’autres erreurs.
succeeded	La build s’est terminée avec succès.

BuildStatus

Énumération

État de la build.

Valeur	Description
all	Tout l’état.
cancelling	La build annule
completed	La build est terminée.
inProgress	La build est actuellement en cours.
none	Aucun état.
notStarted	La build n’a pas encore démarré.
postponed	La build est inactive dans la file d’attente.

ControllerStatus

Énumération

État du contrôleur.

Valeur	Description
available	Indique que le contrôleur de build est actuellement disponible.
offline	Indique que le contrôleur de build s’est mis hors connexion.
unavailable	Indique que le contrôleur de build ne peut pas être contacté.

DefinitionQueueStatus

Énumération

Valeur qui indique si les builds peuvent être mises en file d’attente sur cette définition.

Valeur	Description
disabled	Lorsque la file d’attente de définition est désactivée, les builds ne peuvent pas être mises en file d’attente par les utilisateurs et le système ne met pas en file d’attente les builds d’intégration planifiées, contrôlées ou continues. Les builds déjà dans la file d’attente ne sont pas démarrées par le système.
enabled	Lorsque la file d’attente de définition est activée, les builds peuvent être mises en file d’attente par les utilisateurs, le système met en file d’attente les builds planifiées, contrôlées et continues, et les builds mises en file d’attente sont démarrées par le système.
paused	Lorsque la file d’attente de définition est suspendue, les builds peuvent être mises en file d’attente par les utilisateurs et le système met en file d’attente les builds planifiées, contrôlées et intégrées continues. Les builds de la file d’attente ne sont pas démarrées par le système.

DefinitionReference

Object

Représente une référence à une définition.

Nom	Type	Description
createdDate	string (date-time)	Date de création de cette version de la définition.
id	integer (int32)	ID de la définition référencée.
name	string	Nom de la définition référencée.
path	string	Chemin d’accès du dossier de la définition.
project	TeamProjectReference	Référence au projet.
queueStatus	DefinitionQueueStatus	Valeur qui indique si les builds peuvent être mises en file d’attente sur cette définition.
revision	integer (int32)	Numéro de révision de définition.
type	DefinitionType	Type de la définition.
uri	string	URI de la définition.
url	string	URL REST de la définition.

DefinitionType

Énumération

Type de la définition.

Valeur	Description
build
xaml

Demand

Object

Représente une demande utilisée par une définition ou une build.

Nom	Type	Description
name	string	Nom de la fonctionnalité référencée par la demande.
value	string	Valeur demandée.

IdentityRef

Object

Nom	Type	Description
_links	ReferenceLinks	Ce champ contient zéro ou plus de liens intéressants sur le sujet du graphe. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.
descriptor	string	Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique sur les comptes et les organisations.
directoryAlias	string	Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « auto » du dictionnaire IdentityRef « _links »
displayName	string	Il s’agit du nom complet non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id	string
imageUrl	string	Déconseillé - Disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links »
inactive	boolean	Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links »
isAadIdentity	boolean	Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef
uniqueName	string	Déconseillé : utiliser Domain+PrincipalName à la place
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphe.

ProjectState

Énumération

État du projet.

Valeur	Description
all	Tous les projets, quel que soit l’état, sauf supprimé.
createPending	Project a été mis en file d’attente pour la création, mais le processus n’a pas encore démarré.
deleted	Le projet a été supprimé.
deleting	Le projet est en cours de suppression.
new	Le projet est en cours de création.
unchanged	Le projet n’a pas été modifié.
wellFormed	Le projet est entièrement créé et prêt à être utilisé.

ProjectVisibility

Énumération

Visibilité du projet.

Valeur	Description
private	Le projet n’est visible que par les utilisateurs disposant d’un accès explicite.
public	Le projet est visible pour tous.

PropertiesCollection

Object

La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (n’importe quel type avec un TypeCode != TypeCode.Object) à l’exception de DBNull sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type, d’autres primitives sont retunées sous forme de chaîne. Byte[] attendu comme chaîne encodée en base64.

Nom	Type	Description
count	integer (int32)	Nombre de propriétés dans la collection.
item	object
keys	string[]	Jeu de clés dans la collection.
values	string[]	Ensemble de valeurs dans la collection.

QueueOptions

Énumération

Options supplémentaires pour mettre en file d’attente la build.

Valeur	Description
doNotRun	Créez un ID de plan pour la build, ne l’exécutez pas
none	Aucune option de file d’attente

QueuePriority

Énumération

Priorité de la build.

Valeur	Description
aboveNormal	Au-dessus de la priorité normale.
belowNormal	En dessous de la priorité normale.
high	Priorité élevée.
low	Priorité faible.
normal	Priorité normale.

ReferenceLinks

Object

Classe à représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

TaskAgentPoolReference

Object

Représente une référence à un pool d’agents.

Nom	Type	Description
id	integer (int32)	ID du pool.
isHosted	boolean	Valeur indiquant si ce pool est géré ou non par le service.
name	string	Nom du pool.

TaskOrchestrationPlanReference

Object

Représente une référence à un plan d’orchestration.

Nom	Type	Description
orchestrationType	integer (int32)	Type du plan.
planId	string (uuid)	ID du plan.

TeamProjectReference

Object

Représente une référence superficielle à un TeamProject.

Nom	Type	Description
abbreviation	string	Abréviation du projet.
defaultTeamImageUrl	string	URL de l’image d’identité d’équipe par défaut.
description	string	Description du projet (le cas échéant).
id	string (uuid)	Identificateur du projet.
lastUpdateTime	string (date-time)	Heure de la dernière mise à jour du projet.
name	string	Nom du projet.
revision	integer (int64)	Révision du projet.
state	ProjectState	État du projet.
url	string	URL vers la version complète de l’objet.
visibility	ProjectVisibility	Visibilité du projet.

ValidationResult

Énumération

Résultat.

Valeur	Description
error
ok
warning

Partager via

Builds - Queue

Paramètres URI

Corps de la demande

Réponses

Sécurité

oauth2

Étendues

Définitions

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