Builds - Queue

Service:

Build

API Version:

5.0

Zasadí sestavení do fronty.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
project	path	True	string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavena na hodnotu 5.0.
checkInTicket	query		string
ignoreWarnings	query		boolean
sourceBuildId	query		integer int32

Text požadavku

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
buildNumber	string	Číslo nebo název sestavení.
buildNumberRevision	integer	Revize čísla buildu.
controller	BuildController	Kontroler sestavení. Toto nastavení je nastaveno pouze v případě, že typ definice je Xaml.
definition	DefinitionReference	Definice přidružená k sestavení.
deleted	boolean	Označuje, jestli bylo sestavení odstraněno.
deletedBy	IdentityRef	Identita procesu nebo osoby, která odstranila sestavení.
deletedDate	string	Datum odstranění sestavení.
deletedReason	string	Popis způsobu odstranění sestavení
demands	Demand[]	Seznam požadavků, který představuje možnosti agenta vyžadované tímto buildem.
finishTime	string	Čas, kdy se sestavení dokončilo.
id	integer	ID sestavení.
keepForever	boolean	Určuje, jestli se má sestavení přeskočit zásadami uchovávání informací.
lastChangedBy	IdentityRef	Identita představující proces nebo osobu, která naposledy změnila sestavení.
lastChangedDate	string	Datum poslední změny sestavení
logs	BuildLogReference	Informace o protokolech sestavení
orchestrationPlan	TaskOrchestrationPlanReference	Plán orchestrace pro sestavení.
parameters	string	Parametry sestavení.
plans	TaskOrchestrationPlanReference[]	Plány orchestrace přidružené k sestavení (sestavení, vyčištění)
priority	QueuePriority	Priorita sestavení.
project	TeamProjectReference	Týmový projekt.
properties	PropertiesCollection	Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Jsou přijímány hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Objectvýjimkou DBNull ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitivy se přelaďují jako String. Byte[] byl očekáván jako řetězec s kódováním base64.
quality	string	Kvalita sestavení XAML (dobré, špatné atd.)
queue	AgentPoolQueue	Fronta. Toto nastavení je nastaveno pouze v případě, že typ definice je Sestavení.
queueOptions	QueueOptions	Další možnosti pro řazení sestavení do fronty
queuePosition	integer	Aktuální pozice sestavení ve frontě.
queueTime	string	Čas, kdy bylo sestavení zařazeno do fronty.
reason	BuildReason	Důvod vytvoření sestavení
repository	BuildRepository	Úložiště.
requestedBy	IdentityRef	Identita, která zařadila sestavení do fronty.
requestedFor	IdentityRef	Identita, jejímž jménem bylo sestavení zařazeno do fronty.
result	BuildResult	Výsledek sestavení.
retainedByRelease	boolean	Označuje, jestli je sestavení uchováno ve vydané verzi.
sourceBranch	string	Zdrojová větev.
sourceVersion	string	Zdrojová verze.
startTime	string	Čas, kdy bylo sestavení spuštěno.
status	BuildStatus	Stav sestavení.
tags	string[]
triggerInfo	object	Informace specifické pro sourceprovider o tom, co aktivovalo sestavení
triggeredByBuild	Build	Sestavení, které aktivovalo toto sestavení prostřednictvím triggeru dokončení sestavení.
uri	string	Identifikátor URI sestavení.
url	string	Adresa URL REST sestavení.
validationResults	BuildRequestValidationResult[]	Představuje výsledek ověření žádosti o sestavení.

Odpovědi

Name	Typ	Description
200 OK	Build	úspěšná operace

Zabezpečení

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

Name	Description
vso.build_execute	Uděluje možnost přístupu k artefaktům sestavení, včetně výsledků sestavení, definic a požadavků, a možnost zařadit sestavení do fronty, aktualizovat vlastnosti sestavení a přijímat oznámení o událostech sestavení prostřednictvím připojení služeb.

Definice

Name	Description
AgentPoolQueue	Představuje frontu pro spouštění sestavení.
Build	Reprezentace dat sestavení.
BuildController
BuildLogReference	Představuje odkaz na protokol sestavení.
BuildReason	Důvod vytvoření sestavení
BuildRepository	Představuje úložiště používané definicí sestavení.
BuildRequestValidationResult	Představuje výsledek ověření žádosti o sestavení.
BuildResult	Výsledek sestavení
BuildStatus	Stav sestavení.
ControllerStatus	Stav kontroleru.
DefinitionQueueStatus	Hodnota, která označuje, zda sestavení mohou být zařazena do fronty proti této definici.
DefinitionReference	Představuje odkaz na definici.
DefinitionType	Typ definice.
Demand	Představuje požadavek používaný definicí nebo sestavením.
IdentityRef
ProjectState	Stav projektu.
ProjectVisibility	Viditelnost projektu.
PropertiesCollection	Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Jsou přijímány hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Objectvýjimkou DBNull ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitivy se přelaďují jako String. Byte[] byl očekáván jako řetězec s kódováním base64.
QueueOptions	Další možnosti pro přidání sestavení do fronty
QueuePriority	Priorita sestavení
ReferenceLinks	Třída představující kolekci odkazů REST.
TaskAgentPoolReference	Představuje odkaz na fond agentů.
TaskOrchestrationPlanReference	Představuje odkaz na plán orchestrace.
TeamProjectReference	Představuje povrchní odkaz na TeamProject.
ValidationResult	Výsledek.

AgentPoolQueue

Představuje frontu pro spouštění sestavení.

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
id	integer	ID fronty.
name	string	Název fronty.
pool	TaskAgentPoolReference	Fond používaný touto frontou.
url	string	Úplný odkaz http na prostředek.

Build

Reprezentace dat sestavení.

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
buildNumber	string	Číslo nebo název sestavení.
buildNumberRevision	integer	Revize čísla buildu.
controller	BuildController	Kontroler sestavení. Toto nastavení je nastaveno pouze v případě, že typ definice je Xaml.
definition	DefinitionReference	Definice přidružená k sestavení.
deleted	boolean	Označuje, jestli bylo sestavení odstraněno.
deletedBy	IdentityRef	Identita procesu nebo osoby, která odstranila sestavení.
deletedDate	string	Datum odstranění sestavení
deletedReason	string	Popis způsobu odstranění sestavení.
demands	Demand[]	Seznam požadavků, který představuje možnosti agenta vyžadované tímto buildem.
finishTime	string	Čas, kdy se sestavení dokončilo.
id	integer	ID sestavení.
keepForever	boolean	Určuje, jestli se má sestavení přeskočit zásadami uchovávání informací.
lastChangedBy	IdentityRef	Identita představující proces nebo osobu, která naposledy změnila sestavení.
lastChangedDate	string	Datum poslední změny sestavení
logs	BuildLogReference	Informace o protokolech sestavení
orchestrationPlan	TaskOrchestrationPlanReference	Plán orchestrace pro sestavení.
parameters	string	Parametry sestavení.
plans	TaskOrchestrationPlanReference[]	Plány orchestrace přidružené k sestavení (sestavení, vyčištění)
priority	QueuePriority	Priorita sestavení.
project	TeamProjectReference	Týmový projekt.
properties	PropertiesCollection	Třída představuje kontejner vlastností jako kolekci párů klíč-hodnota. Přijímají se hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Objectvýjimkou DBNull ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitiva se přeladí jako String. Byte[] byl očekáván jako řetězec kódovaný jako base64.
quality	string	Kvalita sestavení XAML (dobré, špatné atd.)
queue	AgentPoolQueue	Fronta. Toto nastavení je nastaveno pouze v případě, že je typ definice Sestavení.
queueOptions	QueueOptions	Další možnosti pro přidání sestavení do fronty
queuePosition	integer	Aktuální pozice sestavení ve frontě.
queueTime	string	Čas, kdy bylo sestavení zařazeno do fronty.
reason	BuildReason	Důvod vytvoření sestavení
repository	BuildRepository	Úložiště.
requestedBy	IdentityRef	Identita, která zařadila sestavení do fronty.
requestedFor	IdentityRef	Identita, jejímž jménem bylo sestavení zařazeno do fronty.
result	BuildResult	Výsledek sestavení
retainedByRelease	boolean	Určuje, jestli je sestavení zachováno ve vydané verzi.
sourceBranch	string	Zdrojová větev.
sourceVersion	string	Zdrojová verze.
startTime	string	Čas, kdy bylo sestavení spuštěno.
status	BuildStatus	Stav sestavení.
tags	string[]
triggerInfo	object	Informace specifické pro sourceprovider o tom, co aktivovalo sestavení
triggeredByBuild	Build	Sestavení, které aktivovalo toto sestavení prostřednictvím triggeru dokončení sestavení.
uri	string	Identifikátor URI sestavení.
url	string	Adresa URL REST sestavení.
validationResults	BuildRequestValidationResult[]	Představuje výsledek ověření žádosti o sestavení.

BuildController

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
createdDate	string	Datum vytvoření kontroleru.
description	string	Popis kontroleru.
enabled	boolean	Určuje, jestli je kontroler povolený.
id	integer	ID prostředku
name	string	Název propojeného prostředku (název definice, název kontroleru atd.)
status	ControllerStatus	Stav kontroleru.
updatedDate	string	Datum poslední aktualizace kontroleru.
uri	string	Identifikátor URI kontroleru
url	string	Úplný odkaz HTTP na prostředek

BuildLogReference

Představuje odkaz na protokol sestavení.

Name	Typ	Description
id	integer	ID protokolu.
type	string	Typ umístění protokolu.
url	string	Úplné propojení s prostředkem protokolu.

BuildReason

Důvod vytvoření sestavení

Name	Typ	Description
all	string	Všechny důvody.
batchedCI	string	Sestavení bylo spuštěno pro trigger TriggerType.BatchedContinuousIntegration.
buildCompletion	string	Sestavení bylo spuštěno po dokončení jiného sestavení.
checkInShelveset	string	Sestavení bylo spuštěno pro trigger ContinuousIntegrationType.Gated.
individualCI	string	Sestavení bylo spuštěno pro trigger TriggerType.ContinuousIntegration.
manual	string	Sestavení bylo spuštěno ručně.
none	string	Žádný důvod. Tato hodnota by se neměla používat.
pullRequest	string	Sestavení bylo zahájeno žádostí o přijetí změn. Přidáno ve verzi prostředku 3.
schedule	string	Sestavení bylo spuštěno pro trigger TriggerType.Schedule.
triggered	string	Sestavení se aktivovalo pro účely zásad uchovávání informací.
userCreated	string	Sestavení vytvořil uživatel.
validateShelveset	string	Sestavení bylo spuštěno ručně kvůli privátnímu ověření.

BuildRepository

Představuje úložiště používané definicí sestavení.

Name	Typ	Description
checkoutSubmodules	boolean	Určuje, jestli se mají rezervovat dílčí režimy.
clean	string	Určuje, jestli se má při získávání kódu z úložiště vyčistit cílová složka.
defaultBranch	string	Název výchozí větve.
id	string	ID úložiště.
name	string	Popisný název úložiště.
properties	object
rootFolder	string	Kořenová složka.
type	string	Typ úložiště.
url	string	Adresa URL úložiště.

BuildRequestValidationResult

Představuje výsledek ověření žádosti o sestavení.

Name	Typ	Description
message	string	Zpráva přidružená k výsledku.
result	ValidationResult	Výsledek.

BuildResult

Výsledek sestavení

Name	Typ	Description
canceled	string	Sestavení bylo před spuštěním zrušeno.
failed	string	Sestavení se úspěšně dokončilo.
none	string	Žádný výsledek
partiallySucceeded	string	Kompilace sestavení se úspěšně dokončila, ale došlo k jiným chybám.
succeeded	string	Sestavení bylo úspěšně dokončeno.

BuildStatus

Stav sestavení.

Name	Typ	Description
all	string	Stav vše.
cancelling	string	Build se ruší.
completed	string	Sestavení bylo dokončeno.
inProgress	string	Právě probíhá sestavování.
none	string	Žádný stav.
notStarted	string	Sestavení ještě nebylo spuštěno.
postponed	string	Sestavení není ve frontě aktivní.

ControllerStatus

Stav kontroleru.

Name	Typ	Description
available	string	Označuje, že je aktuálně k dispozici kontroler sestavení.
offline	string	Označuje, že kontroler sestavení přešel do režimu offline.
unavailable	string	Označuje, že nelze kontaktovat kontroler sestavení.

DefinitionQueueStatus

Hodnota, která označuje, zda sestavení mohou být zařazena do fronty proti této definici.

Name	Typ	Description
disabled	string	Při zakázání definiční fronta neumožní zařadit sestavení do fronty podle uživatelů a systém nebude zařadit do fronty naplánovaná, chráněná ani průběžná integrace sestavení. Sestavení, která už jsou ve frontě, systém nespíše.
enabled	string	Když je tato možnost povolená, fronta definic umožňuje zařadit sestavení do fronty podle uživatelů, systém za frontu přidá naplánovaná, chráněná a průběžná integrace sestavení a sestavení zařazená do fronty spustí systém.
paused	string	Když je fronta definic pozastavená, umožní uživatelům zařadit sestavení do fronty a systém do fronty přidá naplánovaná, chráněná a průběžná integrační sestavení. Systém nespustit sestavení ve frontě.

DefinitionReference

Představuje odkaz na definici.

Name	Typ	Description
createdDate	string	Datum vytvoření definice.
id	integer	ID odkazované definice.
name	string	Název odkazované definice.
path	string	Cesta ke složce definice.
project	TeamProjectReference	Odkaz na projekt.
queueStatus	DefinitionQueueStatus	Hodnota, která označuje, zda je možné sestavení zařadit do fronty pro tuto definici.
revision	integer	Číslo revize definice.
type	DefinitionType	Typ definice.
uri	string	Identifikátor URI definice
url	string	Adresa URL REST definice.

DefinitionType

Typ definice.

Name	Typ	Description
build	string
xaml	string

Demand

Představuje požadavek používaný definicí nebo sestavením.

Name	Typ	Description
name	string	Název funkce, na kterou odkazuje poptávka.
value	string	Požadavkem je hodnota.

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo více zajímavých odkazů o předmětu grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu napříč účty i organizacemi.
directoryAlias	string
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

ProjectState

Stav projektu.

Name	Typ	Description
all	string	Všechny projekty bez ohledu na stav.
createPending	string	Projekt byl zařazen do fronty k vytvoření, ale tento proces ještě nebyl zahájen.
deleted	string	Projekt byl odstraněn.
deleting	string	Projekt se právě odstraňuje.
new	string	Projekt se právě vytváří.
unchanged	string	Projekt nebyl změněn.
wellFormed	string	Projekt je zcela vytvořený a připravený k použití.

ProjectVisibility

Viditelnost projektu.

Name	Typ	Description
private	string	Projekt je viditelný pouze uživatelům s explicitním přístupem.
public	string	Projekt je viditelný pro všechny.

PropertiesCollection

Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Jsou přijímány hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Objectvýjimkou DBNull ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitivy se přelaďují jako String. Byte[] byl očekáván jako řetězec s kódováním base64.

Name	Typ	Description
count	integer	Počet vlastností v kolekci.
item	object
keys	string[]	Sada klíčů v kolekci.
values	string[]	Sada hodnot v kolekci.

QueueOptions

Další možnosti pro přidání sestavení do fronty

Name	Typ	Description
doNotRun	string	Vytvoření ID plánu pro sestavení, nespouštět ho
none	string	Žádné možnosti fronty

QueuePriority

Priorita sestavení

Name	Typ	Description
aboveNormal	string	Vyšší než normální priorita.
belowNormal	string	Pod normální prioritou.
high	string	Vysoká priorita.
low	string	Nízká priorita.
normal	string	Normální priorita.

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako jen pro čtení.

TaskAgentPoolReference

Představuje odkaz na fond agentů.

Name	Typ	Description
id	integer	ID fondu.
isHosted	boolean	Hodnota označující, jestli je tento fond spravovaný službou.
name	string	Název fondu.

TaskOrchestrationPlanReference

Představuje odkaz na plán orchestrace.

Name	Typ	Description
orchestrationType	integer	Typ plánu.
planId	string	ID plánu.

TeamProjectReference

Představuje povrchní odkaz na TeamProject.

Name	Typ	Description
abbreviation	string	Zkratka projektu.
defaultTeamImageUrl	string	Adresa URL výchozího obrázku týmové identity
description	string	Popis projektu (pokud existuje).
id	string	Identifikátor projektu.
name	string	Název projektu.
revision	integer	Revize projektu.
state	ProjectState	Stav projektu.
url	string	Adresa URL pro úplnou verzi objektu.
visibility	ProjectVisibility	Viditelnost projektu.

ValidationResult

Výsledek.

Name	Typ	Description
error	string
oK	string
warning	string