Definitions - Create

Usługa:

Build

Wersja interfejsu API:

7.1

Tworzy nową definicję.

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

Z parametrami opcjonalnymi:

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

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. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.
definitionToCloneId	query		integer (int32)
definitionToCloneRevision	query		integer (int32)

Treść żądania

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
authoredBy	IdentityRef	Autor definicji.
badgeEnabled	boolean	Wskazuje, czy dla tej definicji są włączone znaczki.
buildNumberFormat	string	Format numeru kompilacji.
comment	string	Komentarz czasu zaoszczędzenia dla definicji.
createdDate	string (date-time)	Data utworzenia tej wersji definicji.
demands	Demand[]	Reprezentuje zapotrzebowanie używane przez definicję lub kompilację.
description	string	Opis.
draftOf	DefinitionReference	Odwołanie do definicji, z którą ta definicja jest wersją roboczą, jeśli jest to definicja robocza.
drafts	DefinitionReference[]	Lista wersji roboczych skojarzonych z tą definicją, jeśli nie jest to definicja robocza.
dropLocation	string	Lokalizacja upuszczania definicji.
id	integer (int32)	Identyfikator definicji, do których odwołuje się odwołanie.
jobAuthorizationScope	BuildAuthorizationScope	Zakres autoryzacji zadania dla kompilacji w kolejce względem tej definicji.
jobCancelTimeoutInMinutes	integer (int32)	Limit czasu anulowania zadania (w minutach) dla kompilacji anulowanych przez użytkownika dla tej definicji.
jobTimeoutInMinutes	integer (int32)	Limit czasu wykonywania zadania (w minutach) dla kompilacji w kolejce względem tej definicji.
latestBuild	Build	Reprezentacja danych kompilacji.
latestCompletedBuild	Build	Reprezentacja danych kompilacji.
metrics	BuildMetric[]	Reprezentuje metadane dotyczące kompilacji w systemie.
name	string	Nazwa przywołynej definicji.
options	BuildOption[]	Reprezentuje zastosowanie opcjonalnego zachowania do definicji kompilacji.
path	string	Ścieżka folderu definicji.
process	BuildProcess	Proces kompilacji.
processParameters	ProcessParameters	Parametry procesu dla tej definicji.
project	TeamProjectReference	Odwołanie do projektu.
properties	PropertiesCollection	Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Akceptowane są wartości wszystkich typów pierwotnych (dowolnego typu z TypeCode != TypeCode.Object), z wyjątkiem DBNull. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są zmieniane jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.
quality	DefinitionQuality	Jakość dokumentu definicji (wersja robocza itp.)
queue	AgentPoolQueue	Domyślna kolejka kompilacji jest uruchamiana względem tej definicji.
queueStatus	DefinitionQueueStatus	Wartość wskazująca, czy kompilacje mogą być kolejkowane względem tej definicji.
repository	BuildRepository	Repozytorium.
retentionRules	RetentionPolicy[]	Reprezentuje zasady przechowywania definicji kompilacji.
revision	integer (int32)	Numer poprawki definicji.
tags	string[]
triggers	BuildTrigger[]	Reprezentuje wyzwalacz definicji buld.
type	DefinitionType	Typ definicji.
uri	string	Identyfikator URI definicji.
url	string	Adres URL REST definicji.
variableGroups	VariableGroup[]	Reprezentuje grupę zmiennych.
variables	<string,  BuildDefinitionVariable>

Odpowiedzi

Nazwa	Typ	Opis
200 OK	BuildDefinition	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

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

Zakresy

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.
AuthorizationHeader
Build	Reprezentacja danych kompilacji.
BuildAuthorizationScope	Zakres autoryzacji zadania dla kompilacji w kolejce względem tej definicji.
BuildController
BuildDefinition	Reprezentuje definicję kompilacji.
BuildDefinitionVariable	Reprezentuje zmienną używaną przez definicję kompilacji.
BuildLogReference	Reprezentuje odwołanie do dziennika kompilacji.
BuildMetric	Reprezentuje metadane dotyczące kompilacji w systemie.
BuildOption	Reprezentuje zastosowanie opcjonalnego zachowania do definicji kompilacji.
BuildOptionDefinitionReference	Reprezentuje odwołanie do definicji opcji kompilacji.
BuildProcess	Reprezentuje proces 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.
BuildTrigger	Reprezentuje wyzwalacz definicji buld.
ControllerStatus	Stan kontrolera.
DataSourceBindingBase	Reprezentuje powiązanie źródła danych dla żądania punktu końcowego usługi.
DefinitionQuality	Jakość dokumentu definicji (wersja robocza itp.)
DefinitionQueueStatus	Wartość wskazująca, czy kompilacje mogą być kolejkowane względem tej definicji.
DefinitionReference	Reprezentuje odwołanie do definicji.
DefinitionTriggerType	Typ wyzwalacza.
DefinitionType	Typ definicji.
Demand	Reprezentuje zapotrzebowanie używane przez definicję lub kompilację.
IdentityRef
ProcessParameters
ProjectState	Stan projektu.
ProjectVisibility	Widoczność projektu.
PropertiesCollection	Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Akceptowane są wartości wszystkich typów pierwotnych (dowolnego typu z TypeCode != TypeCode.Object), z wyjątkiem DBNull. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są zmieniane 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.
RetentionPolicy	Reprezentuje zasady przechowywania definicji kompilacji.
TaskAgentPoolReference	Reprezentuje odwołanie do puli agentów.
TaskInputDefinitionBase
TaskInputValidation
TaskOrchestrationPlanReference	Reprezentuje odwołanie do planu aranżacji.
TaskSourceDefinitionBase
TeamProjectReference	Reprezentuje płytkie odwołanie do projektu TeamProject.
ValidationResult	Wynik.
VariableGroup	Reprezentuje grupę zmiennych.

AgentPoolQueue

Objekt

Reprezentuje kolejkę do uruchamiania kompilacji.

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

AgentSpecification

Objekt

Specyfikacja agenta zdefiniowanego przez dostawcę puli.

Nazwa	Typ	Opis
identifier	string	Unikatowy identyfikator specyfikacji agenta.

AuthorizationHeader

Objekt

Nazwa	Typ	Opis
name	string
value	string

Build

Objekt

Reprezentacja danych kompilacji.

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 (int32)	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 (date-time)	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 (date-time)	Czas ukończenia kompilacji.
id	integer (int32)	Identyfikator kompilacji.
lastChangedBy	IdentityRef	Tożsamość reprezentująca proces lub osobę, która ostatnio zmieniła kompilację.
lastChangedDate	string (date-time)	Data ostatniej zmiany kompilacji.
logs	BuildLogReference	Informacje o dziennikach kompilacji.
orchestrationPlan	TaskOrchestrationPlanReference	Plan aranżacji kompilacji.
parameters	string	Parametry kompilacji.
plans	TaskOrchestrationPlanReference[]	Plany aranżacji 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ść. Akceptowane są wartości wszystkich typów pierwotnych (dowolnego typu z TypeCode != TypeCode.Object), z wyjątkiem DBNull. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są zmieniane 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 (int32)	Bieżące położenie kompilacji w kolejce.
queueTime	string (date-time)	Czas kolejki kompilacji.
reason	BuildReason	Przyczyna utworzenia kompilacji.
repository	BuildRepository	Repozytorium.
requestedBy	IdentityRef	Tożsamość, która w kolejce kompilacji.
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 (date-time)	Czas rozpoczęcia kompilacji.
status	BuildStatus	Stan kompilacji.
tags	string[]
templateParameters	object	Parametry do obliczania wyrażenia szablonu
triggerInfo	object	Informacje specyficzne dla dostawcy źródła dotyczące wyzwalanej kompilacji
triggeredByBuild	Build	Kompilacja, która wyzwoliła tę kompilację za pomocą wyzwalacza uzupełniania kompilacji.
uri	string	Identyfikator URI kompilacji.
url	string	Adres URL REST kompilacji.
validationResults	BuildRequestValidationResult[]	Reprezentuje wynik weryfikacji żądania kompilacji.

BuildAuthorizationScope

Wyliczanie

Zakres autoryzacji zadania dla kompilacji w kolejce względem tej definicji.

Wartość	Opis
project	Używana tożsamość powinna mieć uprawnienia konta usługi kompilacji ograniczone do projektu, w którym znajduje się definicja kompilacji. Jest to przydatne w przypadku izolacji zadań kompilacji w konkretnym projekcie zespołowym, aby uniknąć niezamierzonej eskalacji ataków uprzywilejowanych podczas kompilacji.
projectCollection	Używana tożsamość powinna mieć uprawnienia konta usługi kompilacji ograniczone do kolekcji projektów. Jest to przydatne, gdy zasoby dla pojedynczej kompilacji są rozłożone na wiele projektów.

BuildController

Objekt

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

BuildDefinition

Objekt

Reprezentuje definicję kompilacji.

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
authoredBy	IdentityRef	Autor definicji.
badgeEnabled	boolean	Wskazuje, czy dla tej definicji są włączone znaczki.
buildNumberFormat	string	Format numeru kompilacji.
comment	string	Komentarz czasu zaoszczędzenia dla definicji.
createdDate	string (date-time)	Data utworzenia tej wersji definicji.
demands	Demand[]	Reprezentuje zapotrzebowanie używane przez definicję lub kompilację.
description	string	Opis.
draftOf	DefinitionReference	Odwołanie do definicji, z którą ta definicja jest wersją roboczą, jeśli jest to definicja robocza.
drafts	DefinitionReference[]	Lista wersji roboczych skojarzonych z tą definicją, jeśli nie jest to definicja robocza.
dropLocation	string	Lokalizacja upuszczania definicji.
id	integer (int32)	Identyfikator definicji, do których odwołuje się odwołanie.
jobAuthorizationScope	BuildAuthorizationScope	Zakres autoryzacji zadania dla kompilacji w kolejce względem tej definicji.
jobCancelTimeoutInMinutes	integer (int32)	Limit czasu anulowania zadania (w minutach) dla kompilacji anulowanych przez użytkownika dla tej definicji.
jobTimeoutInMinutes	integer (int32)	Limit czasu wykonywania zadania (w minutach) dla kompilacji w kolejce względem tej definicji.
latestBuild	Build	Reprezentacja danych kompilacji.
latestCompletedBuild	Build	Reprezentacja danych kompilacji.
metrics	BuildMetric[]	Reprezentuje metadane dotyczące kompilacji w systemie.
name	string	Nazwa przywołynej definicji.
options	BuildOption[]	Reprezentuje zastosowanie opcjonalnego zachowania do definicji kompilacji.
path	string	Ścieżka folderu definicji.
process	BuildProcess	Proces kompilacji.
processParameters	ProcessParameters	Parametry procesu dla tej definicji.
project	TeamProjectReference	Odwołanie do projektu.
properties	PropertiesCollection	Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Akceptowane są wartości wszystkich typów pierwotnych (dowolnego typu z TypeCode != TypeCode.Object), z wyjątkiem DBNull. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są zmieniane jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.
quality	DefinitionQuality	Jakość dokumentu definicji (wersja robocza itp.)
queue	AgentPoolQueue	Domyślna kolejka kompilacji jest uruchamiana względem tej definicji.
queueStatus	DefinitionQueueStatus	Wartość wskazująca, czy kompilacje mogą być kolejkowane względem tej definicji.
repository	BuildRepository	Repozytorium.
retentionRules	RetentionPolicy[]	Reprezentuje zasady przechowywania definicji kompilacji.
revision	integer (int32)	Numer poprawki definicji.
tags	string[]
triggers	BuildTrigger[]	Reprezentuje wyzwalacz definicji buld.
type	DefinitionType	Typ definicji.
uri	string	Identyfikator URI definicji.
url	string	Adres URL REST definicji.
variableGroups	VariableGroup[]	Reprezentuje grupę zmiennych.
variables	<string,  BuildDefinitionVariable>

BuildDefinitionVariable

Objekt

Reprezentuje zmienną używaną przez definicję kompilacji.

Nazwa	Typ	Opis
allowOverride	boolean	Wskazuje, czy wartość można ustawić w czasie kolejki.
isSecret	boolean	Wskazuje, czy wartość zmiennej jest wpisem tajnym.
value	string	Wartość zmiennej.

BuildLogReference

Objekt

Reprezentuje odwołanie do dziennika kompilacji.

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

BuildMetric

Objekt

Reprezentuje metadane dotyczące kompilacji w systemie.

Nazwa	Typ	Opis
date	string (date-time)	Data zakresu.
intValue	integer (int32)	Wartość.
name	string	Nazwa metryki.
scope	string	Zakres.

BuildOption

Objekt

Reprezentuje zastosowanie opcjonalnego zachowania do definicji kompilacji.

Nazwa	Typ	Opis
definition	BuildOptionDefinitionReference	Odwołanie do opcji kompilacji.
enabled	boolean	Wskazuje, czy zachowanie jest włączone.
inputs	object

BuildOptionDefinitionReference

Objekt

Reprezentuje odwołanie do definicji opcji kompilacji.

Nazwa	Typ	Opis
id	string (uuid)	Identyfikator opcji kompilacji, do których odwołuje się odwołanie.

BuildProcess

Objekt

Reprezentuje proces kompilacji.

Nazwa	Typ	Opis
type	integer (int32)	Typ procesu.

BuildReason

Wyliczanie

Przyczyna utworzenia kompilacji.

Wartość	Opis
all	Wszystkie powody.
batchedCI	Kompilacja została uruchomiona dla wyzwalacza TriggerType.BatchedContinuousIntegration.
buildCompletion	Kompilacja została uruchomiona po zakończeniu innej kompilacji.
checkInShelveset	Kompilacja została uruchomiona dla wyzwalacza ContinuousIntegrationType.Gated.
individualCI	Kompilacja została uruchomiona dla wyzwalacza TriggerType.ContinuousIntegration.
manual	Kompilacja została uruchomiona ręcznie.
none	Nie ma powodu. Ta wartość nie powinna być używana.
pullRequest	Kompilacja została uruchomiona przez żądanie ściągnięcia. Dodano element w wersji 3 zasobu.
resourceTrigger	Kompilacja została uruchomiona, gdy zasoby w potoku zostały wyzwolone
schedule	Kompilacja została uruchomiona dla wyzwalacza TriggerType.Schedule.
scheduleForced	Kompilacja została uruchomiona dla wyzwalacza TriggerType.ScheduleForced.
triggered	Kompilacja została wyzwolona na potrzeby zasad przechowywania.
userCreated	Kompilacja została utworzona przez użytkownika.
validateShelveset	Kompilacja została uruchomiona ręcznie w celu weryfikacji prywatnej.

BuildRepository

Objekt

Reprezentuje repozytorium używane przez definicję kompilacji.

Nazwa	Typ	Opis
checkoutSubmodules	boolean	Wskazuje, czy wyewidencjonować moduły podrzędne.
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

Objekt

Reprezentuje wynik weryfikacji żądania kompilacji.

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

BuildResult

Wyliczanie

Wynik kompilacji.

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

BuildStatus

Wyliczanie

Stan kompilacji.

Wartość	Opis
all	Cały stan.
cancelling	Kompilacja jest anulowana
completed	Kompilacja została ukończona.
inProgress	Kompilacja jest obecnie w toku.
none	Brak stanu.
notStarted	Kompilacja nie została jeszcze uruchomiona.
postponed	Kompilacja jest nieaktywna w kolejce.

BuildTrigger

Objekt

Reprezentuje wyzwalacz definicji buld.

Nazwa	Typ	Opis
triggerType	DefinitionTriggerType	Typ wyzwalacza.

ControllerStatus

Wyliczanie

Stan kontrolera.

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

DataSourceBindingBase

Objekt

Reprezentuje powiązanie źródła danych dla żądania punktu końcowego usługi.

Nazwa	Typ	Opis
callbackContextTemplate	string	Format stronicowania obsługiwany przez to źródło danych (ContinuationToken/SkipTop).
callbackRequiredTemplate	string	Potrzebne są kolejne połączenia?
dataSourceName	string	Pobiera lub ustawia nazwę źródła danych.
endpointId	string	Pobiera lub ustawia identyfikator punktu końcowego.
endpointUrl	string	Pobiera lub ustawia adres URL punktu końcowego usługi.
headers	AuthorizationHeader[]	Pobiera lub ustawia nagłówki autoryzacji.
initialContextTemplate	string	Definiuje początkową wartość parametrów zapytania
parameters	object	Pobiera lub ustawia parametry dla źródła danych.
requestContent	string	Pobiera lub ustawia treść żądania HTTP
requestVerb	string	Pobiera lub ustawia czasownik żądania HTTP
resultSelector	string	Pobiera lub ustawia selektor wyników.
resultTemplate	string	Pobiera lub ustawia szablon wyników.
target	string	Pobiera lub ustawia element docelowy źródła danych.

DefinitionQuality

Wyliczanie

Jakość dokumentu definicji (wersja robocza itp.)

Wartość	Opis
definition
draft

DefinitionQueueStatus

Wyliczanie

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

Wartość	Opis
disabled	Po wyłączeniu kolejki definicji nie będzie zezwalać na kolejkowanie kompilacji przez użytkowników, a system nie będzie kolejkować zaplanowanych, zablokowanych ani ciągłych kompilacji integracji. Kompilacje już w kolejce nie będą uruchamiane przez system.
enabled	Po włączeniu kolejki definicji umożliwia tworzenie kompilacji do kolejki 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	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 będą uruchamiane przez system.

DefinitionReference

Objekt

Reprezentuje odwołanie do definicji.

Nazwa	Typ	Opis
createdDate	string (date-time)	Data utworzenia tej wersji definicji.
id	integer (int32)	Identyfikator definicji, do których odwołuje się odwołanie.
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 mogą być kolejkowane względem tej definicji.
revision	integer (int32)	Numer poprawki definicji.
type	DefinitionType	Typ definicji.
uri	string	Identyfikator URI definicji.
url	string	Adres URL REST definicji.

DefinitionTriggerType

Wyliczanie

Typ wyzwalacza.

Wartość	Opis
all	Wszystkie typy.
batchedContinuousIntegration	Kompilację należy uruchomić dla wielu zestawów zmian w określonym interwale.
batchedGatedCheckIn	Kompilacja weryfikacji powinna zostać uruchomiona dla każdej partii ewidencjonowania.
buildCompletion	Kompilacja powinna zostać wyzwolona po zakończeniu innej kompilacji.
continuousIntegration	Kompilacja powinna zostać uruchomiona dla każdego zestawu zmian.
gatedCheckIn	Kompilacja weryfikacji powinna zostać uruchomiona dla każdego zaewidencjonu.
none	Tylko kompilacje ręczne.
pullRequest	Kompilacja powinna zostać wyzwolona po utworzeniu lub zaktualizowaniu żądania ściągnięcia usługi GitHub. Dodano w zasobie w wersji 3
schedule	Kompilację należy uruchomić zgodnie z określonym harmonogramem, niezależnie od tego, czy istnieją zestawy zmian.

DefinitionType

Wyliczanie

Typ definicji.

Wartość	Opis
build
xaml

Demand

Objekt

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

Objekt

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 go pobrać, wykonując zapytanie względem użytkownika programu Graph, do których odwołuje się wpis "self" słownika IdentityRef "_links"
displayName	string	Jest to unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne we wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wykonując zapytanie dotyczące 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 elementu ToIdentityRef
uniqueName	string	Przestarzałe — zamiast tego użyj nazwy głównej i domeny
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

ProcessParameters

Objekt

Nazwa	Typ	Opis
dataSourceBindings	DataSourceBindingBase[]	Reprezentuje powiązanie źródła danych dla żądania punktu końcowego usługi.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectState

Wyliczanie

Stan projektu.

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

ProjectVisibility

Wyliczanie

Widoczność projektu.

Wartość	Opis
private	Projekt jest widoczny tylko dla użytkowników z jawnym dostępem.
public	Projekt jest widoczny dla wszystkich.

PropertiesCollection

Objekt

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

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

QueueOptions

Wyliczanie

Dodatkowe opcje kolejkowania kompilacji.

Wartość	Opis
doNotRun	Tworzenie identyfikatora planu dla kompilacji, nie uruchamiaj go
none	Brak opcji kolejki

QueuePriority

Wyliczanie

Priorytet kompilacji.

Wartość	Opis
aboveNormal	Powyżej normalnego priorytetu.
belowNormal	Poniżej normalnego priorytetu.
high	Wysoki priorytet.
low	Niski priorytet.
normal	Normalny priorytet.

ReferenceLinks

Objekt

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

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

RetentionPolicy

Objekt

Reprezentuje zasady przechowywania definicji kompilacji.

Nazwa	Typ	Opis
artifactTypesToDelete	string[]
artifacts	string[]
branches	string[]
daysToKeep	integer (int32)	Liczba dni przechowywania kompilacji.
deleteBuildRecord	boolean	Wskazuje, czy rekord kompilacji powinien zostać usunięty.
deleteTestResults	boolean	Wskazuje, czy usunąć wyniki testów skojarzone z kompilacją.
minimumToKeep	integer (int32)	Minimalna liczba kompilacji do utrzymania.

TaskAgentPoolReference

Objekt

Reprezentuje odwołanie do puli agentów.

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

TaskInputDefinitionBase

Objekt

Nazwa	Typ	Opis
aliases	string[]
defaultValue	string
groupName	string
helpMarkDown	string
label	string
name	string
options	object
properties	object
required	boolean
type	string
validation	TaskInputValidation
visibleRule	string

TaskInputValidation

Objekt

Nazwa	Typ	Opis
expression	string	Wyrażenie warunkowe
message	string	Komunikat wyjaśniający, jak użytkownik może poprawić, czy walidacja nie powiedzie się

TaskOrchestrationPlanReference

Objekt

Reprezentuje odwołanie do planu aranżacji.

Nazwa	Typ	Opis
orchestrationType	integer (int32)	Typ planu.
planId	string (uuid)	Identyfikator planu.

TaskSourceDefinitionBase

Objekt

Nazwa	Typ	Opis
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

TeamProjectReference

Objekt

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 (uuid)	Identyfikator projektu.
lastUpdateTime	string (date-time)	Czas ostatniej aktualizacji projektu.
name	string	Nazwa projektu.
revision	integer (int64)	Poprawka projektu.
state	ProjectState	Stan projektu.
url	string	Adres URL do pełnej wersji obiektu.
visibility	ProjectVisibility	Widoczność projektu.

ValidationResult

Wyliczanie

Wynik.

Wartość	Opis
error
ok
warning

VariableGroup

Objekt

Reprezentuje grupę zmiennych.

Nazwa	Typ	Opis
alias	string	Nazwa grupy zmiennych.
description	string	Opis.
id	integer (int32)	Identyfikator grupy zmiennych.
name	string	Nazwa grupy zmiennych.
type	string	Typ grupy zmiennych.
variables	<string,  BuildDefinitionVariable>