Builds - Queue

Met en file d’attente une build

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

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-preview.7 » 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 pour représenter une collection de liens de référence REST.

agentSpecification

AgentSpecification

Spécification de l’agent pour la build.

appendCommitMessageToRunName

boolean

Ajouter un message de validation à BuildNumber dans l’interface utilisateur.

buildNumber

string

Numéro/nom de build de la build.

buildNumberRevision

integer

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 à laquelle la build a été supprimée.

deletedReason

string

Description de la façon dont la build a été supprimée.

demands

Demand[]

Liste des demandes qui représente les fonctionnalités de l’agent requises par cette build.

finishTime

string

Heure à laquelle la build a été terminée.

id

integer

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 de la dernière modification de la build.

logs

BuildLogReference

Informations sur les journaux de build.

orchestrationPlan

TaskOrchestrationPlanReference

Plan d’orchestration de 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 en tant que collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un TypeCode != TypeCode.Object) à l’exception de sont DBNull acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. D’autres primitives sont réintégés en tant que String. Byte[] attendu en tant que chaîne encodée en base64.

quality

string

Qualité de la build xaml (bonne, mauvaise, etc.)

queue

AgentPoolQueue

File d'attente. Ce paramètre est défini uniquement si le type de définition est Build. AVERTISSEMENT : ce champ est déprécié et ne correspond pas aux files d’attente des travaux.

queueOptions

QueueOptions

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

queuePosition

integer

Position actuelle de la build dans la file d’attente.

queueTime

string

Heure à laquelle la build a été mise en file d’attente.

reason

BuildReason

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

repository

BuildRepository

Dépôt.

requestedBy

IdentityRef

Identité qui a mis en file d’attente la build.

requestedFor

IdentityRef

Identité pour laquelle la build a été mise en file d’attente.

result

BuildResult

Résultat de build.

retainedByRelease

boolean

Indique si la build est conservée par une version.

sourceBranch

string

Branche source.

sourceVersion

string

Version source.

startTime

string

Heure à laquelle la build a démarré.

status

BuildStatus

État du build.

tags

string[]

templateParameters

object

Paramètres pour l’évaluation de l’expression de modèle

triggerInfo

object

Informations spécifiques à sourceprovider sur 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
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

Nom Description
vso.build_execute Accorde la possibilité d’accéder aux artefacts de build, y compris 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 build via des hooks de service.

Définitions

Nom Description
AgentPoolQueue

Représente une file d’attente pour l’exécution de builds.

AgentSpecification

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

Build

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

BuildController
BuildLogReference

Représente une référence à un journal de build.

BuildReason

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

BuildRepository

Représente un dépôt 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 build.

BuildStatus

Status de build.

ControllerStatus

Status du contrôleur.

DefinitionQueueStatus

Valeur qui indique si les builds peuvent être mises en file d’attente par rapport à 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 (tout 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. Les autres primitives sont réinsérées sous forme de chaîne. Byte[] attendu sous forme de chaîne encodée en base64.

QueueOptions

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

QueuePriority

Priorité de la build.

ReferenceLinks

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

Représente une file d’attente pour l’exécution de builds.

Nom Type Description
_links

ReferenceLinks

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

id

integer

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

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

Nom Type Description
identifier

string

Identificateur unique de la spécification de l’agent.

Build

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

Nom Type Description
_links

ReferenceLinks

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

agentSpecification

AgentSpecification

Spécification de l’agent pour la build.

appendCommitMessageToRunName

boolean

Ajouter le message de validation à BuildNumber dans l’interface utilisateur.

buildNumber

string

Numéro de build/nom de la build.

buildNumberRevision

integer

Révision du numéro de build.

controller

BuildController

Contrôleur de build. Ce paramètre est défini 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 à laquelle la build a été supprimée.

deletedReason

string

Description de la façon dont la build a été supprimée.

demands

Demand[]

Liste des demandes qui représente les fonctionnalités de l’agent requises par cette build.

finishTime

string

Heure à laquelle la build a été terminée.

id

integer

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 de la dernière modification de la build.

logs

BuildLogReference

Informations sur les journaux de build.

orchestrationPlan

TaskOrchestrationPlanReference

Plan d’orchestration de 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 en tant que collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un TypeCode != TypeCode.Object) à l’exception de sont DBNull acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. D’autres primitives sont réintégés en tant que String. Byte[] attendu en tant que chaîne encodée en base64.

quality

string

Qualité de la build xaml (bonne, mauvaise, etc.)

queue

AgentPoolQueue

File d'attente. Ce paramètre est défini uniquement si le type de définition est Build. AVERTISSEMENT : ce champ est déprécié et ne correspond pas aux files d’attente des travaux.

queueOptions

QueueOptions

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

queuePosition

integer

Position actuelle de la build dans la file d’attente.

queueTime

string

Heure à laquelle la build a été mise en file d’attente.

reason

BuildReason

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

repository

BuildRepository

Dépôt.

requestedBy

IdentityRef

Identité qui a mis en file d’attente la build.

requestedFor

IdentityRef

Identité pour laquelle la build a été mise en file d’attente.

result

BuildResult

Résultat de build.

retainedByRelease

boolean

Indique si la build est conservée par une version.

sourceBranch

string

Branche source.

sourceVersion

string

Version source.

startTime

string

Heure à laquelle la build a démarré.

status

BuildStatus

État du build.

tags

string[]

templateParameters

object

Paramètres pour l’évaluation de l’expression de modèle

triggerInfo

object

Informations spécifiques à sourceprovider sur 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

Nom Type Description
_links

ReferenceLinks

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

createdDate

string

Date de création du contrôleur.

description

string

Description du contrôleur.

enabled

boolean

Indique si le contrôleur est activé.

id

integer

ID de la ressource

name

string

Nom de la ressource liée (nom de la définition, nom du contrôleur, etc.)

status

ControllerStatus

Status du contrôleur.

updatedDate

string

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

Représente une référence à un journal de build.

Nom Type Description
id

integer

ID du journal.

type

string

Type de l’emplacement du journal.

url

string

Lien complet vers la ressource de journal.

BuildReason

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

Nom Type Description
all

string

Toutes les raisons.

batchedCI

string

La génération a été démarrée pour le déclencheur TriggerType.BatchedContinuousIntegration.

buildCompletion

string

La build a été démarrée lorsqu’une autre build s’est terminée.

checkInShelveset

string

La build a été démarrée pour le déclencheur ContinuousIntegrationType.Gated.

individualCI

string

La build a été démarrée pour le déclencheur TriggerType.ContinuousIntegration.

manual

string

La build a été démarrée manuellement.

none

string

Aucune raison. Cette valeur ne doit pas être utilisée.

pullRequest

string

La génération a été démarrée par une demande de tirage. Ajout dans la ressource version 3.

resourceTrigger

string

La génération a été démarrée lorsque les ressources du pipeline l’ont déclenchée

schedule

string

La build a été démarrée pour le déclencheur TriggerType.Schedule.

scheduleForced

string

La build a été démarrée pour le déclencheur TriggerType.ScheduleForced.

triggered

string

La génération a été déclenchée à des fins de stratégie de rétention.

userCreated

string

La build a été créée par un utilisateur.

validateShelveset

string

La génération a été démarrée manuellement pour une validation privée.

BuildRepository

Représente un dépôt 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 propre le dossier cible lors de l’obtention du code à partir du dépôt.

defaultBranch

string

Nom du branche par défaut.

id

string

ID du dépôt.

name

string

Nom convivial du dépôt.

properties

object

rootFolder

string

Dossier racine.

type

string

Type du dépôt.

url

string

URL du référentiel.

BuildRequestValidationResult

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

Nom Type Description
message

string

Le message associé au résultat.

result

ValidationResult

Résultat.

BuildResult

Résultat de build.

Nom Type Description
canceled

string

La build a été annulée avant de commencer.

failed

string

La build s’est terminée sans succès.

none

string

Aucun résultat

partiallySucceeded

string

La build a terminé la compilation avec succès, mais a rencontré d’autres erreurs.

succeeded

string

La build s’est terminée avec succès.

BuildStatus

Status de build.

Nom Type Description
all

string

Tout état.

cancelling

string

La build est en cours d’annulation

completed

string

La build est terminée.

inProgress

string

La build est actuellement en cours.

none

string

Aucun état.

notStarted

string

La build n’a pas encore démarré.

postponed

string

La build est inactive dans la file d’attente.

ControllerStatus

Status du contrôleur.

Nom Type Description
available

string

Indique que le contrôleur de build est actuellement disponible.

offline

string

Indique que le contrôleur de build s’est mis hors connexion.

unavailable

string

Indique que le contrôleur de build ne peut pas être contacté.

DefinitionQueueStatus

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

Nom Type Description
disabled

string

Lorsqu’elle est désactivée, la file d’attente de définitions n’autorise pas les builds à ê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, fermées ou continues. Les builds déjà dans la file d’attente ne seront pas démarrées par le système.

enabled

string

Lorsqu’elle est activée, la file d’attente de définitions permet aux builds d’être mises en file d’attente par les utilisateurs, le système met en file d’attente les builds planifiées, fermées et d’intégration continue, et les builds mises en file d’attente sont démarrées par le système.

paused

string

En cas d’interruption, la file d’attente de définitions permet aux builds d’être mises en file d’attente par les utilisateurs et le système met en file d’attente les builds d’intégration planifiées, fermées et continues. Les builds de la file d’attente ne seront pas démarrées par le système.

DefinitionReference

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

Nom Type Description
createdDate

string

Date de création de cette version de la définition.

id

integer

ID de la définition référencée.

name

string

Nom de la définition référencée.

path

string

Chemin 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 par rapport à cette définition.

revision

integer

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

Type de la définition.

Nom Type Description
build

string

xaml

string

Demand

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

Nom Type Description
_links

ReferenceLinks

Ce champ contient zéro ou plus de liens intéressants sur l’objet du graphique. 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 dans 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 « self » du dictionnaire IdentityRef « _links »

displayName

string

Il s’agit du nom d’affichage 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éprécié : 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éprécié : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

Déprécié : 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é : utilisez à la place Domain+PrincipalName

url

string

Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

ProjectState

État du projet.

Nom Type Description
all

string

Tous les projets, quel que soit leur état, à l’exception de Supprimé.

createPending

string

Project a été mis en file d’attente pour la création, mais le processus n’a pas encore démarré.

deleted

string

Le projet a été supprimé.

deleting

string

Le projet est en cours de suppression.

new

string

Le projet est en cours de création.

unchanged

string

Le projet n’a pas été modifié.

wellFormed

string

Le projet est entièrement créé et prêt à être utilisé.

ProjectVisibility

Visibilité du projet.

Nom Type Description
private

string

Le projet n’est visible que par les utilisateurs disposant d’un accès explicite.

public

string

Le projet est visible par tous.

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 (tout 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. Les autres primitives sont réinsérées sous forme de chaîne. Byte[] attendu sous forme de chaîne encodée en base64.

Nom Type Description
count

integer

Nombre de propriétés dans la collection.

item

object

keys

string[]

Ensemble de clés dans la collection.

values

string[]

Ensemble de valeurs dans la collection.

QueueOptions

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

Nom Type Description
doNotRun

string

Créez un ID de plan pour la build, ne l’exécutez pas

none

string

Aucune option de file d’attente

QueuePriority

Priorité de la build.

Nom Type Description
aboveNormal

string

Au-dessus de la priorité normale.

belowNormal

string

En dessous de la priorité normale.

high

string

Haute priorité.

low

string

Priorité basse.

normal

string

Priorité normale.

Classe pour 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 référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

TaskAgentPoolReference

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

Nom Type Description
id

integer

ID de pool.

isHosted

boolean

Valeur indiquant si ce pool est géré ou non par le service.

name

string

Nom du pool.

TaskOrchestrationPlanReference

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

Nom Type Description
orchestrationType

integer

Type du plan.

planId

string

ID du plan.

TeamProjectReference

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

Nom Type Description
abbreviation

string

Abréviation de 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

Identificateur de projet.

lastUpdateTime

string

Heure de la dernière mise à jour du projet.

name

string

Nom du projet.

revision

integer

Révision du projet.

state

ProjectState

État du projet.

url

string

Url de la version complète de l’objet.

visibility

ProjectVisibility

Visibilité du projet.

ValidationResult

Résultat.

Nom Type Description
error

string

ok

string

warning

string