Builds - Queue

Služba:

Build

Verze rozhraní API:

7.1

Zařadí sestavení do fronty.

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

S volitelnými parametry:

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

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. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.
checkInTicket	query		string
definitionId	query		integer (int32)	Volitelné ID definice pro zařadí sestavení do fronty bez textu. Ignorováno, pokud existuje platný text.
ignoreWarnings	query		boolean
sourceBuildId	query		integer (int32)

Text požadavku

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
agentSpecification	AgentSpecification	Specifikace agenta pro sestavení.
appendCommitMessageToRunName	boolean	Připojte zprávu potvrzení k buildNumber v uživatelském rozhraní.
buildNumber	string	Číslo nebo název sestavení.
buildNumberRevision	integer (int32)	Revize čísla buildu.
controller	BuildController	Kontroler sestavení. Toto nastavení je nastaveno pouze v případě, že je typ definice Xaml.
definition	DefinitionReference	Definice přidružená k sestavení.
deleted	boolean	Určuje, jestli se sestavení odstranilo.
deletedBy	IdentityRef	Identita procesu nebo osoby, která sestavení odstranila.
deletedDate	string (date-time)	Datum odstranění sestavení.
deletedReason	string	Popis odstranění sestavení.
demands	Demand[]	Seznam požadavků, které představují možnosti agenta vyžadované tímto buildem.
finishTime	string (date-time)	Čas dokončení sestavení
id	integer (int32)	ID sestavení.
lastChangedBy	IdentityRef	Identita představující proces nebo osobu, která naposledy změnila sestavení.
lastChangedDate	string (date-time)	Datum poslední změny sestavení.
logs	BuildLogReference	Informace o protokolech sestavení
orchestrationPlan	TaskOrchestrationPlanReference	Plán orchestrace 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. Hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Object) s výjimkou DBNull jsou přijímány. Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají jejich typ, další primitivy jsou přeladěny jako String. Bajt[] 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 typ definice je Build. UPOZORNĚNÍ: Toto pole je zastaralé a neodpovídá frontám úloh.
queueOptions	QueueOptions	Další možnosti pro zařadění sestavení do fronty
queuePosition	integer (int32)	Aktuální pozice sestavení ve frontě.
queueTime	string (date-time)	Čas, kdy se sestavení zařadilo do fronty
reason	BuildReason	Důvod vytvoření sestavení.
repository	BuildRepository	Úložiště.
requestedBy	IdentityRef	Identita, která sestavení zařadila do fronty.
requestedFor	IdentityRef	Identita, jejíž jménem se sestavení zařadilo 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 (date-time)	Čas, kdy bylo sestavení spuštěno.
status	BuildStatus	Stav sestavení.
tags	string[]
templateParameters	object	Parametry vyhodnocení výrazu šablony
triggerInfo	object	Informace specifické pro zdroj zdroje o tom, co aktivovalo sestavení
triggeredByBuild	Build	Sestavení, které toto sestavení aktivovalo 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

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

Name	Description
vso.build_execute	Uděluje možnost získat přístup 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 možnost přijímat oznámení o událostech sestavení prostřednictvím volání služeb.

Definice

Name	Description
AgentPoolQueue	Představuje frontu pro spouštění sestavení.
AgentSpecification	Specifikace agenta definovaného poskytovatelem fondu
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 lze sestavení zařadit do fronty proti této definici.
DefinitionReference	Představuje odkaz na definici.
DefinitionType	Typ definice.
Demand	Představuje poptávku používanou 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. Hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Object) s výjimkou DBNull jsou přijímány. Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají jejich typ, další primitivy jsou přeladěny jako String. Bajt[] byl očekáván jako řetězec kódovaný jako base64.
QueueOptions	Další možnosti pro zařadě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 mělký odkaz na TeamProject.
ValidationResult	Výsledek.

AgentPoolQueue

Objekt

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

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

AgentSpecification

Objekt

Specifikace agenta definovaného poskytovatelem fondu

Name	Typ	Description
identifier	string	Jedinečný identifikátor specifikace agenta.

Build

Objekt

Reprezentace dat sestavení

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
agentSpecification	AgentSpecification	Specifikace agenta pro sestavení.
appendCommitMessageToRunName	boolean	Připojte zprávu potvrzení k buildNumber v uživatelském rozhraní.
buildNumber	string	Číslo nebo název sestavení.
buildNumberRevision	integer (int32)	Revize čísla buildu.
controller	BuildController	Kontroler sestavení. Toto nastavení je nastaveno pouze v případě, že je typ definice Xaml.
definition	DefinitionReference	Definice přidružená k sestavení.
deleted	boolean	Určuje, jestli se sestavení odstranilo.
deletedBy	IdentityRef	Identita procesu nebo osoby, která sestavení odstranila.
deletedDate	string (date-time)	Datum odstranění sestavení.
deletedReason	string	Popis odstranění sestavení.
demands	Demand[]	Seznam požadavků, které představují možnosti agenta vyžadované tímto buildem.
finishTime	string (date-time)	Čas dokončení sestavení
id	integer (int32)	ID sestavení.
lastChangedBy	IdentityRef	Identita představující proces nebo osobu, která naposledy změnila sestavení.
lastChangedDate	string (date-time)	Datum poslední změny sestavení.
logs	BuildLogReference	Informace o protokolech sestavení
orchestrationPlan	TaskOrchestrationPlanReference	Plán orchestrace 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. Hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Object) s výjimkou DBNull jsou přijímány. Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají jejich typ, další primitivy jsou přeladěny jako String. Bajt[] 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 typ definice je Build. UPOZORNĚNÍ: Toto pole je zastaralé a neodpovídá frontám úloh.
queueOptions	QueueOptions	Další možnosti pro zařadění sestavení do fronty
queuePosition	integer (int32)	Aktuální pozice sestavení ve frontě.
queueTime	string (date-time)	Čas, kdy se sestavení zařadilo do fronty
reason	BuildReason	Důvod vytvoření sestavení.
repository	BuildRepository	Úložiště.
requestedBy	IdentityRef	Identita, která sestavení zařadila do fronty.
requestedFor	IdentityRef	Identita, jejíž jménem se sestavení zařadilo 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 (date-time)	Čas, kdy bylo sestavení spuštěno.
status	BuildStatus	Stav sestavení.
tags	string[]
templateParameters	object	Parametry vyhodnocení výrazu šablony
triggerInfo	object	Informace specifické pro zdroj zdroje o tom, co aktivovalo sestavení
triggeredByBuild	Build	Sestavení, které toto sestavení aktivovalo 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

Objekt

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

BuildLogReference

Objekt

Představuje odkaz na protokol sestavení.

Name	Typ	Description
id	integer (int32)	ID protokolu.
type	string	Typ umístění protokolu.
url	string	Úplný odkaz na prostředek protokolu.

BuildReason

Výčet

Důvod vytvoření sestavení.

Hodnota	Description
none	Žádný důvod. Tato hodnota by neměla být použita.
manual	Sestavení bylo spuštěno ručně.
individualCI	Sestavení se spustilo pro trigger TriggerType.ContinuousIntegration.
batchedCI	Sestavení se spustilo pro trigger TriggerType.BatchedContinuousIntegration.
schedule	Sestavení se spustilo pro trigger TriggerType.Schedule.
scheduleForced	Sestavení se spustilo pro trigger TriggerType.ScheduleForced.
userCreated	Sestavení vytvořil uživatel.
validateShelveset	Sestavení bylo spuštěno ručně pro privátní ověřování.
checkInShelveset	Sestavení se spustilo pro trigger ContinuousIntegrationType.Gated.
pullRequest	Sestavení spustila žádost o přijetí změn. Přidáno do prostředku verze 3.
buildCompletion	Sestavení se spustilo po dokončení jiného sestavení.
resourceTrigger	Sestavení se spustilo, když ho aktivovaly prostředky v kanálu.
triggered	Sestavení se aktivovalo pro účely zásad uchovávání informací.
all	Všechny důvody.

BuildRepository

Objekt

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

Name	Typ	Description
checkoutSubmodules	boolean	Určuje, jestli se mají dílčímoduly rezervovat.
clean	string	Určuje, jestli chcete vyčistit cílovou složku při získávání kódu z úložiště.
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

Objekt

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ýčet

Výsledek sestavení.

Hodnota	Description
none	Žádný výsledek
succeeded	Sestavení bylo úspěšně dokončeno.
partiallySucceeded	Kompilace sestavení byla úspěšně dokončena, ale měla jiné chyby.
failed	Sestavení bylo úspěšně dokončeno.
canceled	Sestavení bylo před zahájením zrušeno.

BuildStatus

Výčet

Stav sestavení.

Hodnota	Description
none	Žádný stav.
inProgress	Sestavení právě probíhá.
completed	Sestavení bylo dokončeno.
cancelling	Sestavení se ruší.
postponed	Sestavení je ve frontě neaktivní.
notStarted	Sestavení ještě nezačlo.
all	Stav všech.

ControllerStatus

Výčet

Stav kontroleru.

Hodnota	Description
unavailable	Označuje, že kontroler sestavení nelze kontaktovat.
available	Označuje, že kontroler sestavení je aktuálně dostupný.
offline	Označuje, že se kontroler sestavení přešel do režimu offline.

DefinitionQueueStatus

Výčet

Hodnota, která označuje, zda lze sestavení zařadit do fronty proti této definici.

Hodnota	Description
enabled	Pokud je fronta definic povolená, umožní uživatelům zařadit sestavení do fronty, systém zařadí naplánované, zaměněné a sestavení kontinuální integrace a systém spustí sestavení ve frontě.
paused	Když se fronta definic pozastaví, umožní uživatelům zařadit sestavení do fronty a systém zařadí naplánované, zaměněné a kontinuální integrace buildy. Sestavení ve frontě nebudou systémem spuštěna.
disabled	Pokud je fronta definic zakázaná, nedovolí, aby se buildy zařadily do fronty uživatelům a systém nebude zařadit do fronty naplánované, zaměněné ani sestavení kontinuální integrace. Sestavení, která už jsou ve frontě, nebudou systémem spuštěna.

DefinitionReference

Objekt

Představuje odkaz na definici.

Name	Typ	Description
createdDate	string (date-time)	Datum vytvoření této verze definice.
id	integer (int32)	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 lze sestavení zařadit do fronty proti této definici.
revision	integer (int32)	Číslo revize definice.
type	DefinitionType	Typ definice.
uri	string	Identifikátor URI definice.
url	string	Adresa URL REST definice.

DefinitionType

Výčet

Typ definice.

Hodnota	Description
xaml
build

Demand

Objekt

Představuje poptávku používanou definicí nebo sestavením.

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

IdentityRef

Objekt

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo zajímavější odkazy na téma grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto tématu grafu.
descriptor	string	Popisovač je primární způsob, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejné téma grafu v rámci účtů i organizací.
directoryAlias	string	Zastaralé – Je možné načíst dotazováním uživatele Graphu, na který odkazuje položka "self" slovníku IdentityRef "_links".
displayName	string	Toto je ne jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém zprostředkovateli.
id	string
imageUrl	string	Zastaralé – k dispozici v položce avatar ve slovníku IdentityRef "_links"
inactive	boolean	Zastaralé – Lze načíst dotazem na stav členství v grafu odkazovaném v položce "membershipState" slovníku GraphUser "_links"
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

ProjectState

Výčet

Stav projektu

Hodnota	Description
deleting	Projekt probíhá v procesu odstranění.
new	Projekt probíhá při vytváření.
wellFormed	Projekt je zcela vytvořený a připravený k použití.
createPending	Projekt byl zařazen do fronty pro vytvoření, ale proces ještě nebyl spuštěn.
all	Všechny projekty bez ohledu na stav kromě Odstraněno.
unchanged	Projekt nebyl změněn.
deleted	Projekt byl odstraněn.

ProjectVisibility

Výčet

Viditelnost projektu

Hodnota	Description
private	Projekt je viditelný jenom uživatelům s explicitním přístupem.
public	Projekt je viditelný pro všechny.

PropertiesCollection

Objekt

Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Object) s výjimkou DBNull jsou přijímány. Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají jejich typ, další primitivy jsou přeladěny jako String. Bajt[] byl očekáván jako řetězec kódovaný jako base64.

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

QueueOptions

Výčet

Další možnosti pro zařadění sestavení do fronty

Hodnota	Description
none	Žádné možnosti fronty
doNotRun	Vytvořte ID plánu pro sestavení, nespustíte ho.

QueuePriority

Výčet

Priorita sestavení.

Hodnota	Description
low	Nízká priorita.
belowNormal	Pod normální prioritou.
normal	Normální priorita.
aboveNormal	Nad normální prioritou.
high	Vysoká priorita.

ReferenceLinks

Objekt

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

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

TaskAgentPoolReference

Objekt

Představuje odkaz na fond agentů.

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

TaskOrchestrationPlanReference

Objekt

Představuje odkaz na plán orchestrace.

Name	Typ	Description
orchestrationType	integer (int32)	Typ plánu.
planId	string (uuid)	ID plánu.

TeamProjectReference

Objekt

Představuje mělký odkaz na TeamProject.

Name	Typ	Description
abbreviation	string	Zkratka projektu.
defaultTeamImageUrl	string	Adresa URL výchozí image týmové identity
description	string	Popis projektu (pokud existuje).
id	string (uuid)	Identifikátor projektu.
lastUpdateTime	string (date-time)	Čas poslední aktualizace projektu
name	string	Název projektu.
revision	integer (int64)	Revize projektu
state	ProjectState	Stav projektu
url	string	Adresa URL úplné verze objektu.
visibility	ProjectVisibility	Viditelnost projektu

ValidationResult

Výčet

Výsledek.

Hodnota	Description
ok
warning
error