Builds - Queue

Riferimento

Servizio:: Build

Versione API:: 7.1

Accoda una compilazione

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path	True	string	ID progetto o nome progetto
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1' per usare questa versione dell'API.
checkInTicket	query		string
definitionId	query		integer (int32)	ID definizione facoltativo per accodare una compilazione senza corpo. Ignorato se è presente un corpo valido
ignoreWarnings	query		boolean
sourceBuildId	query		integer (int32)

Corpo della richiesta

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
agentSpecification	AgentSpecification	Specifica dell'agente per la compilazione.
appendCommitMessageToRunName	boolean	Accoda messaggio di commit a BuildNumber nell'interfaccia utente.
buildNumber	string	Numero di build/nome della compilazione.
buildNumberRevision	integer (int32)	Revisione del numero di build.
controller	BuildController	Controller di compilazione. Questa impostazione viene impostata solo se il tipo di definizione è Xaml.
definition	DefinitionReference	Definizione associata alla compilazione.
deleted	boolean	Indica se la compilazione è stata eliminata.
deletedBy	IdentityRef	Identità del processo o della persona che ha eliminato la compilazione.
deletedDate	string (date-time)	Data di eliminazione della compilazione.
deletedReason	string	Descrizione della modalità di eliminazione della compilazione.
demands	Demand[]	Elenco di richieste che rappresenta le funzionalità dell'agente richieste da questa compilazione.
finishTime	string (date-time)	Ora di completamento della compilazione.
id	integer (int32)	ID della compilazione.
lastChangedBy	IdentityRef	Identità che rappresenta il processo o la persona che ha modificato l'ultima compilazione.
lastChangedDate	string (date-time)	Data dell'ultima modifica della compilazione.
logs	BuildLogReference	Informazioni sui log di compilazione.
orchestrationPlan	TaskOrchestrationPlanReference	Piano di orchestrazione per la compilazione.
parameters	string	Parametri per la compilazione.
plans	TaskOrchestrationPlanReference[]	Piani di orchestrazione associati alla compilazione (compilazione, pulizia)
priority	QueuePriority	Priorità della compilazione.
project	TeamProjectReference	Progetto team.
properties	PropertiesCollection	La classe rappresenta un contenitore di proprietà come raccolta di coppie chiave-valore. I valori di tutti i tipi primitivi (qualsiasi tipo con un `TypeCode != TypeCode.Object`) ad eccezione di `DBNull` vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono ricreate come String. Byte[] previsto come stringa con codifica Base64.
quality	string	Qualità della compilazione xaml (buona, cattiva e così via)
queue	AgentPoolQueue	Coda. Questa opzione viene impostata solo se il tipo di definizione è Build. AVVISO: questo campo è deprecato e non corrisponde alle code dei processi.
queueOptions	QueueOptions	Opzioni aggiuntive per accodare la compilazione.
queuePosition	integer (int32)	Posizione corrente della compilazione nella coda.
queueTime	string (date-time)	Ora in cui la compilazione è stata accodata.
reason	BuildReason	Motivo per cui è stata creata la compilazione.
repository	BuildRepository	Repository.
requestedBy	IdentityRef	Identità che ha accodato la compilazione.
requestedFor	IdentityRef	Identità per conto della compilazione accodata.
result	BuildResult	Risultato della compilazione.
retainedByRelease	boolean	Indica se la compilazione viene mantenuta da una versione.
sourceBranch	string	Ramo di origine.
sourceVersion	string	Versione di origine.
startTime	string (date-time)	Ora in cui è stata avviata la compilazione.
status	BuildStatus	Stato della compilazione.
tags	string[]
templateParameters	object	Parametri per la valutazione dell'espressione modello
triggerInfo	object	Informazioni specifiche di Sourceprovider su ciò che ha attivato la compilazione
triggeredByBuild	Build	Compilazione che ha attivato questa compilazione tramite un trigger di completamento della compilazione.
uri	string	URI della compilazione.
url	string	URL REST della compilazione.
validationResults	BuildRequestValidationResult[]	Rappresenta il risultato della convalida di una richiesta di compilazione.

Risposte

Nome	Tipo	Descrizione
200 OK	Build	operazione riuscita

Sicurezza

oauth2

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL 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

Ambiti

Nome	Descrizione
vso.build_execute	Concede la possibilità di accedere agli artefatti di compilazione, inclusi i risultati di compilazione, le definizioni e le richieste e la possibilità di accodare una compilazione, aggiornare le proprietà di compilazione e la possibilità di ricevere notifiche sugli eventi di compilazione tramite hook del servizio.

Definizioni

Nome	Descrizione
AgentPoolQueue	Rappresenta una coda per l'esecuzione di compilazioni.
AgentSpecification	Specifica dell'agente definito dal provider di pool.
Build	Rappresentazione dei dati di una compilazione.
BuildController
BuildLogReference	Rappresenta un riferimento a un log di compilazione.
BuildReason	Motivo per cui è stata creata la compilazione.
BuildRepository	Rappresenta un repository utilizzato da una definizione di compilazione.
BuildRequestValidationResult	Rappresenta il risultato della convalida di una richiesta di compilazione.
BuildResult	Risultato della compilazione.
BuildStatus	Stato della compilazione.
ControllerStatus	Stato del controller.
DefinitionQueueStatus	Valore che indica se le compilazioni possono essere accodate a questa definizione.
DefinitionReference	Rappresenta un riferimento a una definizione.
DefinitionType	Tipo della definizione.
Demand	Rappresenta una richiesta utilizzata da una definizione o da una compilazione.
IdentityRef
ProjectState	Stato del progetto.
ProjectVisibility	Visibilità del progetto.
PropertiesCollection	La classe rappresenta un contenitore di proprietà come raccolta di coppie chiave-valore. I valori di tutti i tipi primitivi (qualsiasi tipo con un `TypeCode != TypeCode.Object`) ad eccezione di `DBNull` vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono ricreate come String. Byte[] previsto come stringa con codifica Base64.
QueueOptions	Opzioni aggiuntive per accodare la compilazione.
QueuePriority	Priorità della compilazione.
ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
TaskAgentPoolReference	Rappresenta un riferimento a un pool di agenti.
TaskOrchestrationPlanReference	Rappresenta un riferimento a un piano di orchestrazione.
TeamProjectReference	Rappresenta un riferimento superficiale a un oggetto TeamProject.
ValidationResult	Il risultato.

AgentPoolQueue

Object

Rappresenta una coda per l'esecuzione di compilazioni.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
id	integer (int32)	ID della coda.
name	string	Nome della coda.
pool	TaskAgentPoolReference	Pool utilizzato da questa coda.
url	string	Collegamento http completo alla risorsa.

AgentSpecification

Object

Specifica dell'agente definito dal provider di pool.

Nome	Tipo	Descrizione
identifier	string	Identificatore univoco della specifica dell'agente.

Build

Object

Rappresentazione dei dati di una compilazione.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
agentSpecification	AgentSpecification	Specifica dell'agente per la compilazione.
appendCommitMessageToRunName	boolean	Accoda messaggio di commit a BuildNumber nell'interfaccia utente.
buildNumber	string	Numero di build/nome della compilazione.
buildNumberRevision	integer (int32)	Revisione del numero di build.
controller	BuildController	Controller di compilazione. Questa impostazione viene impostata solo se il tipo di definizione è Xaml.
definition	DefinitionReference	Definizione associata alla compilazione.
deleted	boolean	Indica se la compilazione è stata eliminata.
deletedBy	IdentityRef	Identità del processo o della persona che ha eliminato la compilazione.
deletedDate	string (date-time)	Data di eliminazione della compilazione.
deletedReason	string	Descrizione della modalità di eliminazione della compilazione.
demands	Demand[]	Elenco di richieste che rappresenta le funzionalità dell'agente richieste da questa compilazione.
finishTime	string (date-time)	Ora di completamento della compilazione.
id	integer (int32)	ID della compilazione.
lastChangedBy	IdentityRef	Identità che rappresenta il processo o la persona che ha modificato l'ultima compilazione.
lastChangedDate	string (date-time)	Data dell'ultima modifica della compilazione.
logs	BuildLogReference	Informazioni sui log di compilazione.
orchestrationPlan	TaskOrchestrationPlanReference	Piano di orchestrazione per la compilazione.
parameters	string	Parametri per la compilazione.
plans	TaskOrchestrationPlanReference[]	Piani di orchestrazione associati alla compilazione (compilazione, pulizia)
priority	QueuePriority	Priorità della compilazione.
project	TeamProjectReference	Progetto team.
properties	PropertiesCollection	La classe rappresenta un contenitore di proprietà come raccolta di coppie chiave-valore. I valori di tutti i tipi primitivi (qualsiasi tipo con un `TypeCode != TypeCode.Object`) ad eccezione di `DBNull` vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono ricreate come String. Byte[] previsto come stringa con codifica Base64.
quality	string	Qualità della compilazione xaml (buona, cattiva e così via)
queue	AgentPoolQueue	Coda. Questa opzione viene impostata solo se il tipo di definizione è Build. AVVISO: questo campo è deprecato e non corrisponde alle code dei processi.
queueOptions	QueueOptions	Opzioni aggiuntive per accodare la compilazione.
queuePosition	integer (int32)	Posizione corrente della compilazione nella coda.
queueTime	string (date-time)	Ora in cui la compilazione è stata accodata.
reason	BuildReason	Motivo per cui è stata creata la compilazione.
repository	BuildRepository	Repository.
requestedBy	IdentityRef	Identità che ha accodato la compilazione.
requestedFor	IdentityRef	Identità per conto della compilazione accodata.
result	BuildResult	Risultato della compilazione.
retainedByRelease	boolean	Indica se la compilazione viene mantenuta da una versione.
sourceBranch	string	Ramo di origine.
sourceVersion	string	Versione di origine.
startTime	string (date-time)	Ora in cui è stata avviata la compilazione.
status	BuildStatus	Stato della compilazione.
tags	string[]
templateParameters	object	Parametri per la valutazione dell'espressione modello
triggerInfo	object	Informazioni specifiche di Sourceprovider su ciò che ha attivato la compilazione
triggeredByBuild	Build	Compilazione che ha attivato questa compilazione tramite un trigger di completamento della compilazione.
uri	string	URI della compilazione.
url	string	URL REST della compilazione.
validationResults	BuildRequestValidationResult[]	Rappresenta il risultato della convalida di una richiesta di compilazione.

BuildController

Object

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
createdDate	string (date-time)	Data di creazione del controller.
description	string	Descrizione del controller.
enabled	boolean	Indica se il controller è abilitato.
id	integer (int32)	ID della risorsa
name	string	Nome della risorsa collegata (nome della definizione, nome del controller e così via)
status	ControllerStatus	Stato del controller.
updatedDate	string (date-time)	Data dell'ultimo aggiornamento del controller.
uri	string	URI del controller.
url	string	Collegamento HTTP completo alla risorsa

BuildLogReference

Object

Rappresenta un riferimento a un log di compilazione.

Nome	Tipo	Descrizione
id	integer (int32)	ID del log.
type	string	Tipo del percorso del log.
url	string	Collegamento completo alla risorsa di log.

BuildReason

Enumerazione

Motivo per cui è stata creata la compilazione.

Valore	Descrizione
all	Tutti i motivi.
batchedCI	La compilazione è stata avviata per trigger TriggerType.BatchedContinuousIntegration.
buildCompletion	La compilazione è stata avviata al termine di un'altra compilazione.
checkInShelveset	La compilazione è stata avviata per il trigger ContinuousIntegrationType.Gated.
individualCI	La compilazione è stata avviata per il trigger TriggerType.ContinuousIntegration.
manual	La compilazione è stata avviata manualmente.
none	Nessun motivo. Questo valore non deve essere utilizzato.
pullRequest	La compilazione è stata avviata da una richiesta pull. Aggiunta nella versione 3 della risorsa.
resourceTrigger	La compilazione è stata avviata quando le risorse nella pipeline l'hanno attivata
schedule	La compilazione è stata avviata per trigger TriggerType.Schedule.
scheduleForced	La compilazione è stata avviata per il trigger TriggerType.ScheduleForced.
triggered	La compilazione è stata attivata a scopo di criteri di conservazione.
userCreated	La compilazione è stata creata da un utente.
validateShelveset	La compilazione è stata avviata manualmente per la convalida privata.

BuildRepository

Object

Rappresenta un repository utilizzato da una definizione di compilazione.

Nome	Tipo	Descrizione
checkoutSubmodules	boolean	Indica se eseguire il checkout dei moduli secondari.
clean	string	Indica se pulire la cartella di destinazione durante il recupero del codice dal repository.
defaultBranch	string	Nome del ramo predefinito.
id	string	ID del repository.
name	string	Nome descrittivo del repository.
properties	object
rootFolder	string	Cartella radice.
type	string	Tipo del repository.
url	string	URL del repository.

BuildRequestValidationResult

Object

Rappresenta il risultato della convalida di una richiesta di compilazione.

Nome	Tipo	Descrizione
message	string	Messaggio associato al risultato.
result	ValidationResult	Il risultato.

BuildResult

Enumerazione

Risultato della compilazione.

Valore	Descrizione
canceled	La compilazione è stata annullata prima dell'avvio.
failed	La compilazione è stata completata in modo non riuscito.
none	Nessun risultato
partiallySucceeded	La compilazione è stata completata correttamente, ma si sono verificati altri errori.
succeeded	La compilazione è stata completata correttamente.

BuildStatus

Enumerazione

Stato della compilazione.

Valore	Descrizione
all	Tutto lo stato.
cancelling	La compilazione viene annullata
completed	La compilazione è stata completata.
inProgress	La compilazione è attualmente in corso.
none	Nessun stato.
notStarted	La compilazione non è ancora stata avviata.
postponed	La compilazione è inattiva nella coda.

ControllerStatus

Enumerazione

Stato del controller.

Valore	Descrizione
available	Indica che il controller di compilazione è attualmente disponibile.
offline	Indica che il controller di compilazione è stato portato offline.
unavailable	Indica che il controller di compilazione non può essere contattato.

DefinitionQueueStatus

Enumerazione

Valore che indica se le compilazioni possono essere accodate a questa definizione.

Valore	Descrizione
disabled	Se disabilitata, la coda di definizioni non consentirà la coda di compilazioni da parte degli utenti e il sistema non accoderà compilazioni pianificate, gestite o di integrazione continua. Le compilazioni già presenti nella coda non verranno avviate dal sistema.
enabled	Se abilitata, la coda di definizioni consente alle compilazioni di essere accodate dagli utenti, il sistema accoderà compilazioni pianificate, gestite e di integrazione continua e le compilazioni in coda verranno avviate dal sistema.
paused	Quando viene sospesa la coda di definizioni, le compilazioni possono essere accodate dagli utenti e il sistema accoderà compilazioni pianificate, gestite e di integrazione continua. Le compilazioni nella coda non verranno avviate dal sistema.

DefinitionReference

Object

Rappresenta un riferimento a una definizione.

Nome	Tipo	Descrizione
createdDate	string (date-time)	Data di creazione di questa versione della definizione.
id	integer (int32)	ID della definizione a cui si fa riferimento.
name	string	Nome della definizione a cui si fa riferimento.
path	string	Percorso della cartella della definizione.
project	TeamProjectReference	Riferimento al progetto.
queueStatus	DefinitionQueueStatus	Valore che indica se le compilazioni possono essere accodate a questa definizione.
revision	integer (int32)	Numero di revisione della definizione.
type	DefinitionType	Tipo della definizione.
uri	string	URI della definizione.
url	string	URL REST della definizione.

DefinitionType

Enumerazione

Tipo della definizione.

Valore	Descrizione
build
xaml

Demand

Object

Rappresenta una richiesta utilizzata da una definizione o da una compilazione.

Nome	Tipo	Descrizione
name	string	Nome della funzionalità a cui fa riferimento la richiesta.
value	string	Valore richiesto.

IdentityRef

Object

Nome	Tipo	Descrizione
_links	ReferenceLinks	Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate sull'oggetto grafico.
descriptor	string	Il descrittore è il modo principale per fare riferimento all'oggetto del grafo mentre il sistema è in esecuzione. Questo campo identificherà in modo univoco lo stesso soggetto del grafico in account e organizzazioni.
directoryAlias	string	Deprecato: può essere recuperato eseguendo una query sull'utente graph a cui si fa riferimento nella voce "self" del dizionario IdentityRef "_links"
displayName	string	Si tratta del nome visualizzato non univoco dell'oggetto del grafico. Per modificare questo campo, è necessario modificarne il valore nel provider di origine.
id	string
imageUrl	string	Deprecato : disponibile nella voce "avatar" del dizionario IdentityRef "_links"
inactive	boolean	Deprecato: può essere recuperato eseguendo una query sullo stato di appartenenza graph a cui si fa riferimento nella voce "membershipState" del dizionario "_links" GraphUser
isAadIdentity	boolean	Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecato: non in uso nella maggior parte delle implementazioni preesistenti di ToIdentityRef
uniqueName	string	Deprecato: usare invece Domain+PrincipalName
url	string	Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

ProjectState

Enumerazione

Stato del progetto.

Valore	Descrizione
all	Tutti i progetti indipendentemente dallo stato tranne Deleted.
createPending	Il progetto è stato accodato per la creazione, ma il processo non è ancora stato avviato.
deleted	Il progetto è stato eliminato.
deleting	Il progetto è in corso di eliminazione.
new	Il progetto è in fase di creazione.
unchanged	Il progetto non è stato modificato.
wellFormed	Il progetto è completamente creato e pronto per l'uso.

ProjectVisibility

Enumerazione

Visibilità del progetto.

Valore	Descrizione
private	Il progetto è visibile solo agli utenti con accesso esplicito.
public	Il progetto è visibile a tutti.

PropertiesCollection

Object

La classe rappresenta un contenitore di proprietà come raccolta di coppie chiave-valore. I valori di tutti i tipi primitivi (qualsiasi tipo con un TypeCode != TypeCode.Object) ad eccezione di DBNull vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono ricreate come String. Byte[] previsto come stringa con codifica Base64.

Nome	Tipo	Descrizione
count	integer (int32)	Conteggio delle proprietà nell'insieme.
item	object
keys	string[]	Set di chiavi nella raccolta.
values	string[]	Set di valori nell'insieme.

QueueOptions

Enumerazione

Opzioni aggiuntive per accodare la compilazione.

Valore	Descrizione
doNotRun	Creare un ID piano per la compilazione, non eseguirlo
none	Nessuna opzione della coda

QueuePriority

Enumerazione

Priorità della compilazione.

Valore	Descrizione
aboveNormal	Sopra la priorità normale.
belowNormal	Al di sotto della priorità normale.
high	Priorità alta.
low	Priorità bassa.
normal	Priorità normale.

ReferenceLinks

Object

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

TaskAgentPoolReference

Object

Rappresenta un riferimento a un pool di agenti.

Nome	Tipo	Descrizione
id	integer (int32)	ID pool.
isHosted	boolean	Valore che indica se il pool è gestito dal servizio o meno.
name	string	Nome del pool.

TaskOrchestrationPlanReference

Object

Rappresenta un riferimento a un piano di orchestrazione.

Nome	Tipo	Descrizione
orchestrationType	integer (int32)	Tipo del piano.
planId	string (uuid)	ID del piano.

TeamProjectReference

Object

Rappresenta un riferimento superficiale a un oggetto TeamProject.

Nome	Tipo	Descrizione
abbreviation	string	Abbreviazione del progetto.
defaultTeamImageUrl	string	URL dell'immagine di identità del team predefinita.
description	string	Descrizione del progetto (se presente).
id	string (uuid)	Identificatore del progetto.
lastUpdateTime	string (date-time)	Ora dell'ultimo aggiornamento del progetto.
name	string	Nome progetto.
revision	integer (int64)	Revisione del progetto.
state	ProjectState	Stato del progetto.
url	string	URL della versione completa dell'oggetto.
visibility	ProjectVisibility	Visibilità del progetto.

ValidationResult

Enumerazione

Il risultato.

Valore	Descrizione
error
ok
warning

Condividi tramite

Builds - Queue

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

oauth2

Ambiti

Definizioni

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