Builds - Queue

Service:

Build

API Version:

7.1-preview.7

Accoda una compilazione

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

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 del progetto
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1-preview.7' 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	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	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	Ora di completamento della compilazione.
id	integer	ID della compilazione.
lastChangedBy	IdentityRef	Identità che rappresenta il processo o la persona che ha modificato l'ultima compilazione.
lastChangedDate	string	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 DBNull di vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono riattivate come String. Byte[] previsto come stringa con codifica Base64.
quality	string	Qualità della compilazione xaml (buona, cattiva e così via)
queue	AgentPoolQueue	Coda. Questa impostazione 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	Posizione corrente della compilazione nella coda.
queueTime	string	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 cui è stata accodata la compilazione.
result	BuildResult	Risultato della compilazione.
retainedByRelease	boolean	Indica se la compilazione viene mantenuta da una versione.
sourceBranch	string	Ramo di origine.
sourceVersion	string	La versione di origine.
startTime	string	Ora di avvio della compilazione.
status	BuildStatus	Stato della compilazione.
tags	string[]
templateParameters	object	Parametri per la valutazione delle espressioni 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

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

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 di 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 DBNull di vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono riattivate 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	Risultato.

AgentPoolQueue

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	ID della coda.
name	string	Nome della coda.
pool	TaskAgentPoolReference	Pool utilizzato da questa coda.
url	string	Collegamento http completo alla risorsa.

AgentSpecification

Specifica dell'agente definito dal provider di pool.

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

Build

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	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	Data di eliminazione della compilazione.
deletedReason	string	Descrizione della modalità di eliminazione della compilazione.
demands	Demand[]	Elenco delle richieste che rappresenta le funzionalità dell'agente richieste da questa compilazione.
finishTime	string	Ora di completamento della compilazione.
id	integer	ID della compilazione.
lastChangedBy	IdentityRef	Identità che rappresenta il processo o la persona che ha modificato l'ultima compilazione.
lastChangedDate	string	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 DBNull di sono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, altre primitive vengono ritunate come String. Byte[] previsto come stringa codificata base64.
quality	string	Qualità della compilazione xaml (buona, cattiva e così via)
queue	AgentPoolQueue	Coda. Viene impostato 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	Posizione corrente della compilazione nella coda.
queueTime	string	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 cui è stata accodata la compilazione.
result	BuildResult	Risultato della compilazione.
retainedByRelease	boolean	Indica se la compilazione viene mantenuta da una versione.
sourceBranch	string	Ramo di origine.
sourceVersion	string	La versione di origine.
startTime	string	Ora di avvio della compilazione.
status	BuildStatus	Stato della compilazione.
tags	string[]
templateParameters	object	Parametri per la valutazione delle espressioni modello
triggerInfo	object	Informazioni specifiche di Sourceprovider su cosa 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

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
createdDate	string	Data di creazione del controller.
description	string	Descrizione del controller.
enabled	boolean	Indica se il controller è abilitato.
id	integer	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	Data dell'ultimo aggiornamento del controller.
uri	string	URI del controller.
url	string	Collegamento HTTP completo alla risorsa

BuildLogReference

Rappresenta un riferimento a un log di compilazione.

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

BuildReason

Motivo per cui è stata creata la compilazione.

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

BuildRepository

Rappresenta un repository utilizzato da una definizione di compilazione.

Nome	Tipo	Descrizione
checkoutSubmodules	boolean	Indica se eseguire l'estrazione di 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	La cartella radice.
type	string	Tipo del repository.
url	string	URL del repository.

BuildRequestValidationResult

Rappresenta il risultato della convalida di una richiesta di compilazione.

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

BuildResult

Risultato della compilazione.

Nome	Tipo	Descrizione
canceled	string	La compilazione è stata annullata prima dell'avvio.
failed	string	La compilazione è stata completata senza esito positivo.
none	string	Nessun risultato
partiallySucceeded	string	La compilazione completata correttamente, ma ha avuto altri errori.
succeeded	string	La compilazione è stata completata correttamente.

BuildStatus

Stato della compilazione.

Nome	Tipo	Descrizione
all	string	Tutti gli stati.
cancelling	string	La compilazione viene annullata
completed	string	La compilazione è stata completata.
inProgress	string	La compilazione è attualmente in corso.
none	string	Nessuno stato.
notStarted	string	La compilazione non è ancora stata avviata.
postponed	string	La compilazione è inattiva nella coda.

ControllerStatus

Stato del controller.

Nome	Tipo	Descrizione
available	string	Indica che il controller di compilazione è attualmente disponibile.
offline	string	Indica che il controller di compilazione è stato disattivato.
unavailable	string	Indica che il controller di compilazione non può essere contattato.

DefinitionQueueStatus

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

Nome	Tipo	Descrizione
disabled	string	Se disabilitata la coda di definizione non consente la coda di compilazioni da parte degli utenti e il sistema non accoderà le compilazioni pianificate, gated o continue integration build. Le compilazioni già nella coda non verranno avviate dal sistema.
enabled	string	Quando è abilitata la coda di definizione consente alle compilazioni di essere accodate dagli utenti, il sistema eseguirà la coda, le compilazioni di integrazione continua e le compilazioni in coda verranno avviate dal sistema.
paused	string	Quando la coda di definizione è sospesa consente la coda di compilazioni da parte degli utenti e il sistema accoderà le compilazioni pianificate, gated e continue integration build. Le compilazioni nella coda non verranno avviate dal sistema.

DefinitionReference

Rappresenta un riferimento a una definizione.

Nome	Tipo	Descrizione
createdDate	string	Data di creazione della versione della definizione.
id	integer	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	Numero di revisione della definizione.
type	DefinitionType	Tipo di definizione.
uri	string	URI della definizione.
url	string	URL REST della definizione.

DefinitionType

Tipo di definizione.

Nome	Tipo	Descrizione
build	string
xaml	string

Demand

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

Nome	Tipo	Descrizione
_links	ReferenceLinks	Questo campo contiene zero o più collegamenti interessanti sull'oggetto del grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo 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 oggetto 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 "_links" IdentityRef
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 GraphUser "_links"
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

Stato del progetto.

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

ProjectVisibility

Visibilità del progetto.

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

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 DBNull di vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono riattivate come String. Byte[] previsto come stringa con codifica Base64.

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

QueueOptions

Opzioni aggiuntive per accodare la compilazione.

Nome	Tipo	Descrizione
doNotRun	string	Creare un ID piano per la compilazione, non eseguirlo
none	string	Nessuna opzione di coda

QueuePriority

Priorità della compilazione.

Nome	Tipo	Descrizione
aboveNormal	string	Sopra la priorità normale.
belowNormal	string	Sotto la priorità normale.
high	string	Ad alta priorità.
low	string	A bassa priorità.
normal	string	Priorità normale.

ReferenceLinks

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

Rappresenta un riferimento a un pool di agenti.

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

TaskOrchestrationPlanReference

Rappresenta un riferimento a un piano di orchestrazione.

Nome	Tipo	Descrizione
orchestrationType	integer	Tipo del piano.
planId	string	ID del piano.

TeamProjectReference

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	Identificatore del progetto.
lastUpdateTime	string	Ora dell'ultimo aggiornamento del progetto.
name	string	Nome progetto.
revision	integer	Revisione del progetto.
state	ProjectState	Stato del progetto.
url	string	URL della versione completa dell'oggetto.
visibility	ProjectVisibility	Visibilità del progetto.

ValidationResult

Risultato.

Nome	Tipo	Descrizione
error	string
ok	string
warning	string