Builds - Queue

Service:

Build

API Version:

7.1-preview.7

Kolejkuje kompilację

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wartość powinna być ustawiona na wartość "7.1-preview.7", aby używać tej wersji interfejsu API.
checkInTicket	query		string
definitionId	query		integer int32	Opcjonalny identyfikator definicji do kolejki kompilacji bez treści. Ignorowane, jeśli istnieje prawidłowa treść
ignoreWarnings	query		boolean
sourceBuildId	query		integer int32

Treść żądania

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
agentSpecification	AgentSpecification	Specyfikacja agenta kompilacji.
appendCommitMessageToRunName	boolean	Dołącz komunikat zatwierdzenia do buildNumber w interfejsie użytkownika.
buildNumber	string	Numer/nazwa kompilacji.
buildNumberRevision	integer	Poprawka numeru kompilacji.
controller	BuildController	Kontroler kompilacji. Jest to ustawiane tylko wtedy, gdy typ definicji to Xaml.
definition	DefinitionReference	Definicja skojarzona z kompilacją.
deleted	boolean	Wskazuje, czy kompilacja została usunięta.
deletedBy	IdentityRef	Tożsamość procesu lub osoby, która usunęła kompilację.
deletedDate	string	Data usunięcia kompilacji.
deletedReason	string	Opis sposobu usunięcia kompilacji.
demands	Demand[]	Lista żądań reprezentujących możliwości agenta wymagane przez tę kompilację.
finishTime	string	Czas ukończenia kompilacji.
id	integer	Identyfikator kompilacji.
lastChangedBy	IdentityRef	Tożsamość reprezentująca proces lub osobę, która ostatnio zmieniła kompilację.
lastChangedDate	string	Data ostatniej zmiany kompilacji.
logs	BuildLogReference	Informacje o dziennikach kompilacji.
orchestrationPlan	TaskOrchestrationPlanReference	Plan aranżacji kompilacji.
parameters	string	Parametry kompilacji.
plans	TaskOrchestrationPlanReference[]	Plany orkiestracji skojarzone z kompilacją (kompilacja, oczyszczanie)
priority	QueuePriority	Priorytet kompilacji.
project	TeamProjectReference	Projekt zespołowy.
properties	PropertiesCollection	Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolnego typu z wartością TypeCode != TypeCode.Object) z wyjątkiem DBNull są akceptowane. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są dostrojone jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.
quality	string	Jakość kompilacji xaml (dobra, zła itp.)
queue	AgentPoolQueue	Kolejka. Jest to ustawiane tylko wtedy, gdy typ definicji to Kompilacja. OSTRZEŻENIE: to pole jest przestarzałe i nie odpowiada kolejkom zadań.
queueOptions	QueueOptions	Dodatkowe opcje kolejkowania kompilacji.
queuePosition	integer	Bieżąca pozycja kompilacji w kolejce.
queueTime	string	Czas, przez który kompilacja została w kolejce.
reason	BuildReason	Przyczyna utworzenia kompilacji.
repository	BuildRepository	Repozytorium.
requestedBy	IdentityRef	Tożsamość, która kolejkuje kompilację.
requestedFor	IdentityRef	Tożsamość, której imieniu kompilacja została w kolejce.
result	BuildResult	Wynik kompilacji.
retainedByRelease	boolean	Wskazuje, czy kompilacja jest zachowywana przez wydanie.
sourceBranch	string	Gałąź źródłowa.
sourceVersion	string	Wersja źródłowa.
startTime	string	Czas rozpoczęcia kompilacji.
status	BuildStatus	Stan kompilacji.
tags	string[]
templateParameters	object	Parametry do oceny wyrażenia szablonu
triggerInfo	object	Informacje specyficzne dla dostawcy źródła dotyczące tego, co wyzwoliło kompilację
triggeredByBuild	Build	Kompilacja, która wyzwoliła tę kompilację za pośrednictwem wyzwalacza uzupełniania kompilacji.
uri	string	Identyfikator URI kompilacji.
url	string	Adres URL REST kompilacji.
validationResults	BuildRequestValidationResult[]	Reprezentuje wynik weryfikacji żądania kompilacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Build	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.build_execute	Umożliwia dostęp do artefaktów kompilacji, w tym wyników kompilacji, definicji i żądań oraz możliwość kolejkowania kompilacji, aktualizowania właściwości kompilacji oraz odbierania powiadomień o zdarzeniach kompilacji za pośrednictwem punktów zaczepienia usługi.

Definicje

Nazwa	Opis
AgentPoolQueue	Reprezentuje kolejkę do uruchamiania kompilacji.
AgentSpecification	Specyfikacja agenta zdefiniowanego przez dostawcę puli.
Build	Reprezentacja danych kompilacji.
BuildController
BuildLogReference	Reprezentuje odwołanie do dziennika kompilacji.
BuildReason	Przyczyna utworzenia kompilacji.
BuildRepository	Reprezentuje repozytorium używane przez definicję kompilacji.
BuildRequestValidationResult	Reprezentuje wynik weryfikacji żądania kompilacji.
BuildResult	Wynik kompilacji.
BuildStatus	Stan kompilacji.
ControllerStatus	Stan kontrolera.
DefinitionQueueStatus	Wartość wskazująca, czy kompilacje mogą być kolejkowane względem tej definicji.
DefinitionReference	Reprezentuje odwołanie do definicji.
DefinitionType	Typ definicji.
Demand	Reprezentuje zapotrzebowanie używane przez definicję lub kompilację.
IdentityRef
ProjectState	Stan projektu.
ProjectVisibility	Widoczność projektu.
PropertiesCollection	Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolny typ z ) TypeCode != TypeCode.Objectz wyjątkiem są DBNull akceptowane. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są dostrojone jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.
QueueOptions	Dodatkowe opcje kolejkowania kompilacji.
QueuePriority	Priorytet kompilacji.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
TaskAgentPoolReference	Reprezentuje odwołanie do puli agentów.
TaskOrchestrationPlanReference	Reprezentuje odwołanie do planu aranżacji.
TeamProjectReference	Reprezentuje płytkie odwołanie do projektu TeamProject.
ValidationResult	Wynik.

AgentPoolQueue

Reprezentuje kolejkę do uruchamiania kompilacji.

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
id	integer	Identyfikator kolejki.
name	string	Nazwa kolejki.
pool	TaskAgentPoolReference	Pula używana przez tę kolejkę.
url	string	Pełny link http do zasobu.

AgentSpecification

Specyfikacja agenta zdefiniowanego przez dostawcę puli.

Nazwa	Typ	Opis
identifier	string	Unikatowy identyfikator specyfikacji agenta.

Build

Reprezentacja danych kompilacji.

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
agentSpecification	AgentSpecification	Specyfikacja agenta dla kompilacji.
appendCommitMessageToRunName	boolean	Dołącz komunikat zatwierdzenia do buildNumber w interfejsie użytkownika.
buildNumber	string	Numer/nazwa kompilacji.
buildNumberRevision	integer	Poprawka numeru kompilacji.
controller	BuildController	Kontroler kompilacji. Jest to ustawione tylko wtedy, gdy typ definicji to Xaml.
definition	DefinitionReference	Definicja skojarzona z kompilacją.
deleted	boolean	Wskazuje, czy kompilacja została usunięta.
deletedBy	IdentityRef	Tożsamość procesu lub osoby, która usunęła kompilację.
deletedDate	string	Data usunięcia kompilacji.
deletedReason	string	Opis sposobu usunięcia kompilacji.
demands	Demand[]	Lista żądań reprezentujących możliwości agenta wymagane przez tę kompilację.
finishTime	string	Czas ukończenia kompilacji.
id	integer	Identyfikator kompilacji.
lastChangedBy	IdentityRef	Tożsamość reprezentująca proces lub osobę, która ostatnio zmieniła kompilację.
lastChangedDate	string	Data ostatniej zmiany kompilacji.
logs	BuildLogReference	Informacje o dziennikach kompilacji.
orchestrationPlan	TaskOrchestrationPlanReference	Plan aranżacji kompilacji.
parameters	string	Parametry kompilacji.
plans	TaskOrchestrationPlanReference[]	Plany orkiestracji skojarzone z kompilacją (kompilacja, oczyszczanie)
priority	QueuePriority	Priorytet kompilacji.
project	TeamProjectReference	Projekt zespołowy.
properties	PropertiesCollection	Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolnego typu z wartością TypeCode != TypeCode.Object) z wyjątkiem DBNull są akceptowane. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są dostrojone jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.
quality	string	Jakość kompilacji xaml (dobra, zła itp.)
queue	AgentPoolQueue	Kolejka. Jest to ustawiane tylko wtedy, gdy typ definicji to Kompilacja. OSTRZEŻENIE: to pole jest przestarzałe i nie odpowiada kolejkom zadań.
queueOptions	QueueOptions	Dodatkowe opcje kolejkowania kompilacji.
queuePosition	integer	Bieżąca pozycja kompilacji w kolejce.
queueTime	string	Czas, przez który kompilacja została w kolejce.
reason	BuildReason	Przyczyna utworzenia kompilacji.
repository	BuildRepository	Repozytorium.
requestedBy	IdentityRef	Tożsamość, która kolejkuje kompilację.
requestedFor	IdentityRef	Tożsamość, której imieniu kompilacja została w kolejce.
result	BuildResult	Wynik kompilacji.
retainedByRelease	boolean	Wskazuje, czy kompilacja jest zachowywana przez wydanie.
sourceBranch	string	Gałąź źródłowa.
sourceVersion	string	Wersja źródłowa.
startTime	string	Czas rozpoczęcia kompilacji.
status	BuildStatus	Stan kompilacji.
tags	string[]
templateParameters	object	Parametry do oceny wyrażenia szablonu
triggerInfo	object	Informacje specyficzne dla dostawcy źródła dotyczące tego, co wyzwoliło kompilację
triggeredByBuild	Build	Kompilacja, która wyzwoliła tę kompilację za pośrednictwem wyzwalacza uzupełniania kompilacji.
uri	string	Identyfikator URI kompilacji.
url	string	Adres URL REST kompilacji.
validationResults	BuildRequestValidationResult[]	Reprezentuje wynik weryfikacji żądania kompilacji.

BuildController

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
createdDate	string	Data utworzenia kontrolera.
description	string	Opis kontrolera.
enabled	boolean	Wskazuje, czy kontroler jest włączony.
id	integer	Identyfikator zasobu
name	string	Nazwa połączonego zasobu (nazwa definicji, nazwa kontrolera itp.)
status	ControllerStatus	Stan kontrolera.
updatedDate	string	Data ostatniej aktualizacji kontrolera.
uri	string	Identyfikator URI kontrolera.
url	string	Pełny link http do zasobu

BuildLogReference

Reprezentuje odwołanie do dziennika kompilacji.

Nazwa	Typ	Opis
id	integer	Identyfikator dziennika.
type	string	Typ lokalizacji dziennika.
url	string	Pełny link do zasobu dziennika.

BuildReason

Przyczyna utworzenia kompilacji.

Nazwa	Typ	Opis
all	string	Wszystkie powody.
batchedCI	string	Kompilacja została uruchomiona dla wyzwalacza TriggerType.BatchedContinuousIntegration.
buildCompletion	string	Kompilacja została uruchomiona po zakończeniu innej kompilacji.
checkInShelveset	string	Kompilacja została uruchomiona dla wyzwalacza ContinuousIntegrationType.Gated.
individualCI	string	Kompilacja została uruchomiona dla wyzwalacza TriggerType.ContinuousIntegration.
manual	string	Kompilacja została uruchomiona ręcznie.
none	string	Nie ma powodu. Tej wartości nie należy używać.
pullRequest	string	Kompilacja została uruchomiona przez żądanie ściągnięcia. Dodano element w wersji 3 zasobu.
resourceTrigger	string	Kompilacja została uruchomiona po wyzwoleniu zasobów w potoku
schedule	string	Kompilacja została uruchomiona dla wyzwalacza TriggerType.Schedule.
scheduleForced	string	Kompilacja została uruchomiona dla wyzwalacza TriggerType.ScheduleForced.
triggered	string	Kompilacja została wyzwolona na potrzeby zasad przechowywania.
userCreated	string	Kompilacja została utworzona przez użytkownika.
validateShelveset	string	Kompilacja została uruchomiona ręcznie na potrzeby weryfikacji prywatnej.

BuildRepository

Reprezentuje repozytorium używane przez definicję kompilacji.

Nazwa	Typ	Opis
checkoutSubmodules	boolean	Wskazuje, czy wyewidencjonować podmoduły.
clean	string	Wskazuje, czy usunąć folder docelowy podczas pobierania kodu z repozytorium.
defaultBranch	string	Nazwa gałęzi domyślnej.
id	string	Identyfikator repozytorium.
name	string	Przyjazna nazwa repozytorium.
properties	object
rootFolder	string	Folder główny.
type	string	Typ repozytorium.
url	string	Adres URL repozytorium.

BuildRequestValidationResult

Reprezentuje wynik weryfikacji żądania kompilacji.

Nazwa	Typ	Opis
message	string	Komunikat skojarzony z wynikiem.
result	ValidationResult	Wynik.

BuildResult

Wynik kompilacji.

Nazwa	Typ	Opis
canceled	string	Kompilacja została anulowana przed rozpoczęciem.
failed	string	Kompilacja zakończyła się niepowodzeniem.
none	string	Brak wyniku
partiallySucceeded	string	Kompilacja zakończyła się pomyślnie, ale wystąpiły inne błędy.
succeeded	string	Kompilacja została ukończona pomyślnie.

BuildStatus

Stan kompilacji.

Nazwa	Typ	Opis
all	string	Wszystkie stany.
cancelling	string	Kompilacja jest anulowana
completed	string	Kompilacja została ukończona.
inProgress	string	Kompilacja jest obecnie w toku.
none	string	Brak stanu.
notStarted	string	Kompilacja nie została jeszcze uruchomiona.
postponed	string	Kompilacja jest nieaktywna w kolejce.

ControllerStatus

Stan kontrolera.

Nazwa	Typ	Opis
available	string	Wskazuje, że kontroler kompilacji jest obecnie dostępny.
offline	string	Wskazuje, że kontroler kompilacji przejął się w tryb offline.
unavailable	string	Wskazuje, że nie można skontaktować się z kontrolerem kompilacji.

DefinitionQueueStatus

Wartość wskazująca, czy kompilacje mogą być kolejkowane względem tej definicji.

Nazwa	Typ	Opis
disabled	string	Po wyłączeniu kolejki definicji nie będzie zezwalać na kolejkowanie kompilacji przez użytkowników, a system nie będzie kolejkować zaplanowanych, bramowanych ani ciągłych kompilacji integracji. Kompilacje już w kolejce nie będą uruchamiane przez system.
enabled	string	Po włączeniu kolejki definicji umożliwia kolejkowanie kompilacji przez użytkowników, system będzie kolejkować zaplanowane, bramowane i ciągłe kompilacje integracji, a kompilacje w kolejce zostaną uruchomione przez system.
paused	string	Po wstrzymaniu kolejki definicji umożliwia kolejkowanie kompilacji przez użytkowników, a system będzie kolejkować zaplanowane, bramowane i ciągłe kompilacje integracji. Kompilacje w kolejce nie zostaną uruchomione przez system.

DefinitionReference

Reprezentuje odwołanie do definicji.

Nazwa	Typ	Opis
createdDate	string	Data utworzenia tej wersji definicji.
id	integer	Identyfikator przywołynej definicji.
name	string	Nazwa przywołynej definicji.
path	string	Ścieżka folderu definicji.
project	TeamProjectReference	Odwołanie do projektu.
queueStatus	DefinitionQueueStatus	Wartość wskazująca, czy kompilacje można utworzyć w kolejce względem tej definicji.
revision	integer	Numer poprawki definicji.
type	DefinitionType	Typ definicji.
uri	string	Identyfikator URI definicji.
url	string	Adres URL REST definicji.

DefinitionType

Typ definicji.

Nazwa	Typ	Opis
build	string
xaml	string

Demand

Reprezentuje zapotrzebowanie używane przez definicję lub kompilację.

Nazwa	Typ	Opis
name	string	Nazwa możliwości, do których odwołuje się zapotrzebowanie.
value	string	Żądana wartość.

IdentityRef

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwołowania się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string	Przestarzałe — można pobrać, wysyłając zapytanie do użytkownika programu Graph przywoływanego w wpisie "self" słownika IdentityRef "_links"
displayName	string	Jest to unikatowa nazwa wyświetlana tematu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne w wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wysyłając zapytanie do stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links"
isAadIdentity	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Przestarzałe — nie jest używane w większości istniejących implementacji toIdentityRef
uniqueName	string	Przestarzałe — zamiast tego użyj nazwy Domain+PrincipalName
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

ProjectState

Stan projektu.

Nazwa	Typ	Opis
all	string	Wszystkie projekty niezależnie od stanu z wyjątkiem usuniętych.
createPending	string	Projekt został jeszcze w kolejce do utworzenia, ale proces nie został jeszcze uruchomiony.
deleted	string	Projekt został usunięty.
deleting	string	Projekt jest w trakcie usuwania.
new	string	Projekt jest w trakcie tworzenia.
unchanged	string	Projekt nie został zmieniony.
wellFormed	string	Projekt jest całkowicie tworzony i gotowy do użycia.

ProjectVisibility

Widoczność projektu.

Nazwa	Typ	Opis
private	string	Projekt jest widoczny tylko dla użytkowników z jawnym dostępem.
public	string	Projekt jest widoczny dla wszystkich.

PropertiesCollection

Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolny typ z ) TypeCode != TypeCode.Objectz wyjątkiem są DBNull akceptowane. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są dostrojone jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.

Nazwa	Typ	Opis
count	integer	Liczba właściwości w kolekcji.
item	object
keys	string[]	Zestaw kluczy w kolekcji.
values	string[]	Zestaw wartości w kolekcji.

QueueOptions

Dodatkowe opcje kolejkowania kompilacji.

Nazwa	Typ	Opis
doNotRun	string	Tworzenie identyfikatora planu dla kompilacji, nie uruchamiaj go
none	string	Brak opcji kolejki

QueuePriority

Priorytet kompilacji.

Nazwa	Typ	Opis
aboveNormal	string	Powyżej normalnego priorytetu.
belowNormal	string	Poniżej normalnego priorytetu.
high	string	Wysoki priorytet.
low	string	Niski priorytet.
normal	string	Normalny priorytet.

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu.

TaskAgentPoolReference

Reprezentuje odwołanie do puli agentów.

Nazwa	Typ	Opis
id	integer	Identyfikator puli.
isHosted	boolean	Wartość wskazująca, czy ta pula jest zarządzana przez usługę.
name	string	Nazwa puli.

TaskOrchestrationPlanReference

Reprezentuje odwołanie do planu aranżacji.

Nazwa	Typ	Opis
orchestrationType	integer	Typ planu.
planId	string	Identyfikator planu.

TeamProjectReference

Reprezentuje płytkie odwołanie do projektu TeamProject.

Nazwa	Typ	Opis
abbreviation	string	Skrót projektu.
defaultTeamImageUrl	string	Adres URL domyślnego obrazu tożsamości zespołu.
description	string	Opis projektu (jeśli istnieje).
id	string	Identyfikator projektu.
lastUpdateTime	string	Czas ostatniej aktualizacji projektu.
name	string	Nazwa projektu.
revision	integer	Poprawka projektu.
state	ProjectState	Stan projektu.
url	string	Adres URL do pełnej wersji obiektu.
visibility	ProjectVisibility	Widoczność projektu.

ValidationResult

Wynik.

Nazwa	Typ	Opis
error	string
ok	string
warning	string