Templates - Get

Dienst:

Build

API-Version:

7.1

Ruft eine bestimmte Builddefinitionsvorlage ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path	True	string	Projekt-ID oder Projektname
templateId	path	True	string	Die ID der angeforderten Vorlage.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.

Antworten

Name	Typ	Beschreibung
200 OK	BuildDefinitionTemplate	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.build	Gewährt die Möglichkeit, auf Buildartefakte zuzugreifen, einschließlich Buildergebnissen, Definitionen und Anforderungen sowie die Möglichkeit, Benachrichtigungen über Buildereignisse über Dienst-Hooks zu empfangen.

Definitionen

Name	Beschreibung
AgentPoolQueue	Stellt eine Warteschlange für ausgeführte Builds dar.
AgentSpecification	Spezifikation des vom Poolanbieter definierten Agents.
AuthorizationHeader
Build	Datendarstellung eines Builds.
BuildAuthorizationScope	Der Auftragsautorisierungsbereich für Builds, die mit dieser Definition in die Warteschlange gestellt werden.
BuildController
BuildDefinition	Stellt eine Builddefinition dar.
BuildDefinitionTemplate	Stellt eine Vorlage dar, aus der neue Builddefinitionen erstellt werden können.
BuildDefinitionVariable	Stellt eine Variable dar, die von einer Builddefinition verwendet wird.
BuildLogReference	Stellt einen Verweis auf ein Buildprotokoll dar.
BuildMetric	Stellt Metadaten zu Builds im System dar.
BuildOption	Stellt die Anwendung eines optionalen Verhaltens für eine Builddefinition dar.
BuildOptionDefinitionReference	Stellt einen Verweis auf eine Buildoptionsdefinition dar.
BuildProcess	Stellt einen Buildprozess dar.
BuildReason	Der Grund, warum der Build erstellt wurde.
BuildRepository	Stellt ein Repository dar, das von einer Builddefinition verwendet wird.
BuildRequestValidationResult	Stellt das Ergebnis der Überprüfung einer Buildanforderung dar.
BuildResult	Das Buildergebnis.
BuildStatus	Der Buildstatus.
BuildTrigger	Stellt einen Trigger für eine Buld-Definition dar.
ControllerStatus	Der Status des Controllers.
DataSourceBindingBase	Stellt die Bindung der Datenquelle für die Serviceendpunktanforderung dar.
DefinitionQuality	Die Qualität des Definitionsdokuments (Entwurf usw.)
DefinitionQueueStatus	Ein Wert, der angibt, ob Builds für diese Definition in die Warteschlange gestellt werden können.
DefinitionReference	Stellt einen Verweis auf eine Definition dar.
DefinitionTriggerType	Der Typ des Triggers.
DefinitionType	Der Typ der Definition.
Demand	Stellt eine Anforderung dar, die von einer Definition oder einem Build verwendet wird.
IdentityRef
ProcessParameters
ProjectState	Projektstatus.
ProjectVisibility	Projektsichtbarkeit.
PropertiesCollection	Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger Typ mit einem TypeCode != TypeCode.Object) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
QueueOptions	Zusätzliche Optionen für die Warteschlange des Builds.
QueuePriority	Die Priorität des Builds.
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
RetentionPolicy	Stellt eine Aufbewahrungsrichtlinie für eine Builddefinition dar.
TaskAgentPoolReference	Stellt einen Verweis auf einen Agentpool dar.
TaskInputDefinitionBase
TaskInputValidation
TaskOrchestrationPlanReference	Stellt einen Verweis auf einen Orchestrierungsplan dar.
TaskSourceDefinitionBase
TeamProjectReference	Stellt einen flachen Verweis auf ein TeamProject dar.
ValidationResult	Das Ergebnis.
VariableGroup	Stellt eine Variablegruppe dar.

AgentPoolQueue

Objekt

Stellt eine Warteschlange für ausgeführte Builds dar.

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
id	integer (int32)	Die ID der Warteschlange.
name	string	Der Name der Warteschlange.
pool	TaskAgentPoolReference	Der von dieser Warteschlange verwendete Pool.
url	string	Der vollständige HTTP-Link zur Ressource.

AgentSpecification

Objekt

Spezifikation des vom Poolanbieter definierten Agents.

Name	Typ	Beschreibung
identifier	string	Eindeutiger Bezeichner für die Agentspezifikation.

AuthorizationHeader

Objekt

Name	Typ	Beschreibung
name	string
value	string

Build

Objekt

Datendarstellung eines Builds.

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
agentSpecification	AgentSpecification	Die Agentspezifikation für den Build.
appendCommitMessageToRunName	boolean	An BuildNumber in der Benutzeroberfläche eine Commitnachricht anfügen.
buildNumber	string	Die Buildnummer/der Name des Builds.
buildNumberRevision	integer (int32)	Die Revision der Buildnummer.
controller	BuildController	Der Buildcontroller. Dies wird nur festgelegt, wenn der Definitionstyp Xaml ist.
definition	DefinitionReference	Die dem Build zugeordnete Definition.
deleted	boolean	Gibt an, ob der Build gelöscht wurde.
deletedBy	IdentityRef	Die Identität des Prozesses oder der Person, der den Build gelöscht hat.
deletedDate	string (date-time)	Das Datum, an dem der Build gelöscht wurde.
deletedReason	string	Die Beschreibung, wie der Build gelöscht wurde.
demands	Demand[]	Eine Liste der Anforderungen, die die für diesen Build erforderlichen Agent-Funktionen darstellen.
finishTime	string (date-time)	Die Zeit, zu der der Build abgeschlossen wurde.
id	integer (int32)	Die ID des Builds.
lastChangedBy	IdentityRef	Die Identität, die den Prozess oder die Person darstellt, der den Build zuletzt geändert hat.
lastChangedDate	string (date-time)	Das Datum, an dem der Build zuletzt geändert wurde.
logs	BuildLogReference	Informationen zu den Buildprotokollen.
orchestrationPlan	TaskOrchestrationPlanReference	Der Orchestrierungsplan für den Bau.
parameters	string	Die Parameter für den Build.
plans	TaskOrchestrationPlanReference[]	Dem Build zugeordnete Orchestrierungspläne (Build, Bereinigung)
priority	QueuePriority	Die Priorität des Builds.
project	TeamProjectReference	Das Teamprojekt.
properties	PropertiesCollection	Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger Typ mit einem TypeCode != TypeCode.Object) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
quality	string	Die Qualität des XAML-Builds (gut, schlecht usw.)
queue	AgentPoolQueue	Die Warteschlange. Dies wird nur festgelegt, wenn der Definitionstyp Build ist. WARNUNG: Dieses Feld ist veraltet und entspricht nicht den Auftragswarteschlangen.
queueOptions	QueueOptions	Zusätzliche Optionen für die Warteschlange des Builds.
queuePosition	integer (int32)	Die aktuelle Position des Builds in der Warteschlange.
queueTime	string (date-time)	Die Zeit, zu der der Build in die Warteschlange gestellt wurde.
reason	BuildReason	Der Grund, warum der Build erstellt wurde.
repository	BuildRepository	Das Repository.
requestedBy	IdentityRef	Die Identität, die den Build in die Warteschlange gestellt hat.
requestedFor	IdentityRef	Die Identität, in der der Build in die Warteschlange gestellt wurde.
result	BuildResult	Das Buildergebnis.
retainedByRelease	boolean	Gibt an, ob der Build von einer Version beibehalten wird.
sourceBranch	string	Der Quellzweig.
sourceVersion	string	Die Quellversion.
startTime	string (date-time)	Die Zeit, zu der der Build gestartet wurde.
status	BuildStatus	Der Status des Builds.
tags	string[]
templateParameters	object	Parameter für vorlagenausdrucksauswertung
triggerInfo	object	Quellproviderspezifische Informationen dazu, was den Build ausgelöst hat
triggeredByBuild	Build	Der Build, der diesen Build über einen Buildabschlusstrigger ausgelöst hat.
uri	string	Der URI des Builds.
url	string	Die REST-URL des Builds.
validationResults	BuildRequestValidationResult[]	Stellt das Ergebnis der Überprüfung einer Buildanforderung dar.

BuildAuthorizationScope

Enumeration

Der Auftragsautorisierungsbereich für Builds, die mit dieser Definition in die Warteschlange gestellt werden.

Wert	Beschreibung
project	Die verwendete Identität sollte über Builddienstkontoberechtigungen für das Projekt verfügen, in dem sich die Builddefinition befindet. Dies ist nützlich für die Isolierung von Buildaufträgen für ein bestimmtes Teamprojekt, um unbeabsichtigte Eskalationen von Berechtigungsangriffen während eines Builds zu vermeiden.
projectCollection	Die verwendete Identität sollte über Builddienstkontoberechtigungen für die Projektsammlung verfügen. Dies ist nützlich, wenn Ressourcen für einen einzelnen Build auf mehrere Projekte verteilt sind.

BuildController

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
createdDate	string (date-time)	Das Datum, an dem der Controller erstellt wurde.
description	string	Die Beschreibung des Controllers.
enabled	boolean	Gibt an, ob der Controller aktiviert ist.
id	integer (int32)	ID der Ressource
name	string	Name der verknüpften Ressource (Definitionsname, Controllername usw.)
status	ControllerStatus	Der Status des Controllers.
updatedDate	string (date-time)	Das Datum, an dem der Controller zuletzt aktualisiert wurde.
uri	string	Der URI des Controllers.
url	string	Vollständiger HTTP-Link zur Ressource

BuildDefinition

Objekt

Stellt eine Builddefinition dar.

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
authoredBy	IdentityRef	Der Autor der Definition.
badgeEnabled	boolean	Gibt an, ob Badges für diese Definition aktiviert sind.
buildNumberFormat	string	Das Buildnummernformat.
comment	string	Ein Speicherzeitkommentar für die Definition.
createdDate	string (date-time)	Das Datum, an dem diese Version der Definition erstellt wurde.
demands	Demand[]	Stellt eine Anforderung dar, die von einer Definition oder einem Build verwendet wird.
description	string	Die Beschreibung.
draftOf	DefinitionReference	Ein Verweis auf die Definition, für die diese Definition ein Entwurf ist, wenn es sich um eine Entwurfsdefinition handelt.
drafts	DefinitionReference[]	Die Liste der Entwürfe, die dieser Definition zugeordnet sind, wenn dies keine Entwurfsdefinition ist.
dropLocation	string	Der Speicherort für die Definition.
id	integer (int32)	Die ID der referenzierten Definition.
jobAuthorizationScope	BuildAuthorizationScope	Der Auftragsautorisierungsbereich für Builds, die mit dieser Definition in die Warteschlange gestellt werden.
jobCancelTimeoutInMinutes	integer (int32)	Timeout des Auftrags (in Minuten) für vom Benutzer abgebrochene Builds für diese Definition.
jobTimeoutInMinutes	integer (int32)	Das Zeitlimit für die Auftragsausführung (in Minuten) für Builds, die für diese Definition in die Warteschlange gestellt werden.
latestBuild	Build	Datendarstellung eines Builds.
latestCompletedBuild	Build	Datendarstellung eines Builds.
metrics	BuildMetric[]	Stellt Metadaten zu Builds im System dar.
name	string	Der Name der referenzierten Definition.
options	BuildOption[]	Stellt die Anwendung eines optionalen Verhaltens für eine Builddefinition dar.
path	string	Der Ordnerpfad der Definition.
process	BuildProcess	Der Buildprozess.
processParameters	ProcessParameters	Die Prozessparameter für diese Definition.
project	TeamProjectReference	Ein Verweis auf das Projekt.
properties	PropertiesCollection	Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger Typ mit einem TypeCode != TypeCode.Object) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
quality	DefinitionQuality	Die Qualität des Definitionsdokuments (Entwurf usw.)
queue	AgentPoolQueue	Die Standardwarteschlange für Builds wird für diese Definition ausgeführt.
queueStatus	DefinitionQueueStatus	Ein Wert, der angibt, ob Builds für diese Definition in die Warteschlange gestellt werden können.
repository	BuildRepository	Das Repository.
retentionRules	RetentionPolicy[]	Stellt eine Aufbewahrungsrichtlinie für eine Builddefinition dar.
revision	integer (int32)	Die Revisionsnummer der Definition.
tags	string[]
triggers	BuildTrigger[]	Stellt einen Trigger für eine Buld-Definition dar.
type	DefinitionType	Der Typ der Definition.
uri	string	Der URI der Definition.
url	string	Die REST-URL der Definition.
variableGroups	VariableGroup[]	Stellt eine Variablegruppe dar.
variables	<string,  BuildDefinitionVariable>

BuildDefinitionTemplate

Objekt

Stellt eine Vorlage dar, aus der neue Builddefinitionen erstellt werden können.

Name	Typ	Beschreibung
canDelete	boolean	Gibt an, ob die Vorlage gelöscht werden kann.
category	string	Die Vorlagenkategorie.
defaultHostedQueue	string	Eine optionale gehostete Agent-Warteschlange für die Vorlage, die standardmäßig verwendet werden soll.
description	string	Eine Beschreibung der Vorlage.
iconTaskId	string (uuid)	Die ID der Aufgabe, deren Symbol beim Anzeigen dieser Vorlage in der Benutzeroberfläche verwendet wird.
icons	object
id	string	Die ID der Vorlage.
name	string	Der Name der Vorlage.
template	BuildDefinition	Die tatsächliche Vorlage.

BuildDefinitionVariable

Objekt

Stellt eine Variable dar, die von einer Builddefinition verwendet wird.

Name	Typ	Beschreibung
allowOverride	boolean	Gibt an, ob der Wert zur Warteschlangenzeit festgelegt werden kann.
isSecret	boolean	Gibt an, ob der Wert der Variablen ein Geheimschlüssel ist.
value	string	Der Wert der Variablen.

BuildLogReference

Objekt

Stellt einen Verweis auf ein Buildprotokoll dar.

Name	Typ	Beschreibung
id	integer (int32)	Die ID des Protokolls.
type	string	Der Typ des Protokollspeicherorts.
url	string	Ein vollständiger Link zur Protokollressource.

BuildMetric

Objekt

Stellt Metadaten zu Builds im System dar.

Name	Typ	Beschreibung
date	string (date-time)	Das Datum für den Bereich.
intValue	integer (int32)	Der Wert.
name	string	Der Name der Metrik.
scope	string	Der Bereich.

BuildOption

Objekt

Stellt die Anwendung eines optionalen Verhaltens für eine Builddefinition dar.

Name	Typ	Beschreibung
definition	BuildOptionDefinitionReference	Ein Verweis auf die Buildoption.
enabled	boolean	Gibt an, ob das Verhalten aktiviert ist.
inputs	object

BuildOptionDefinitionReference

Objekt

Stellt einen Verweis auf eine Buildoptionsdefinition dar.

Name	Typ	Beschreibung
id	string (uuid)	Die ID der Referenz-Buildoption.

BuildProcess

Objekt

Stellt einen Buildprozess dar.

Name	Typ	Beschreibung
type	integer (int32)	Der Typ des Prozesses.

BuildReason

Enumeration

Der Grund, warum der Build erstellt wurde.

Wert	Beschreibung
all	Alle Gründe.
batchedCI	Der Build wurde für den Trigger TriggerType.BatchedContinuousIntegration gestartet.
buildCompletion	Der Build wurde gestartet, als ein anderer Build abgeschlossen wurde.
checkInShelveset	Der Build wurde für den Trigger ContinuousIntegrationType.Gated gestartet.
individualCI	Der Build wurde für den Trigger TriggerType.ContinuousIntegration gestartet.
manual	Der Build wurde manuell gestartet.
none	Kein Grund. Dieser Wert sollte nicht verwendet werden.
pullRequest	Der Build wurde von einer Pullanforderung gestartet. In Ressourcenversion 3 hinzugefügt.
resourceTrigger	Der Build wurde gestartet, als Ressourcen in der Pipeline sie ausgelöst haben.
schedule	Der Build wurde für den Trigger TriggerType.Schedule gestartet.
scheduleForced	Der Build wurde für den Trigger TriggerType.ScheduleForced gestartet.
triggered	Der Build wurde für Aufbewahrungsrichtlinienzwecke ausgelöst.
userCreated	Der Build wurde von einem Benutzer erstellt.
validateShelveset	Der Build wurde manuell für die private Überprüfung gestartet.

BuildRepository

Objekt

Stellt ein Repository dar, das von einer Builddefinition verwendet wird.

Name	Typ	Beschreibung
checkoutSubmodules	boolean	Gibt an, ob Untermodule auschecken sollen.
clean	string	Gibt an, ob der Zielordner beim Abrufen von Code aus dem Repository bereinigt werden soll.
defaultBranch	string	Der Name der Standardverzweigung.
id	string	Die ID des Repositorys.
name	string	Der Anzeigename des Repositorys.
properties	object
rootFolder	string	Der Stammordner.
type	string	Der Typ des Repositorys.
url	string	Die URL des Repositorys.

BuildRequestValidationResult

Objekt

Stellt das Ergebnis der Überprüfung einer Buildanforderung dar.

Name	Typ	Beschreibung
message	string	Die Nachricht, die dem Ergebnis zugeordnet ist.
result	ValidationResult	Das Ergebnis.

BuildResult

Enumeration

Das Buildergebnis.

Wert	Beschreibung
canceled	Der Build wurde vor dem Start abgebrochen.
failed	Der Build wurde nicht erfolgreich abgeschlossen.
none	Kein Ergebnis
partiallySucceeded	Die Buildkompilierung wurde erfolgreich abgeschlossen, hatte aber andere Fehler.
succeeded	Der Build wurde erfolgreich abgeschlossen.

BuildStatus

Enumeration

Der Buildstatus.

Wert	Beschreibung
all	Alle Status.
cancelling	Der Build wird abgebrochen.
completed	Der Build wurde abgeschlossen.
inProgress	Der Build wird derzeit ausgeführt.
none	Kein Status.
notStarted	Der Build wurde noch nicht gestartet.
postponed	Der Build ist in der Warteschlange inaktiv.

BuildTrigger

Objekt

Stellt einen Trigger für eine Buld-Definition dar.

Name	Typ	Beschreibung
triggerType	DefinitionTriggerType	Der Typ des Triggers.

ControllerStatus

Enumeration

Der Status des Controllers.

Wert	Beschreibung
available	Gibt an, dass der Buildcontroller zurzeit verfügbar ist.
offline	Gibt an, dass der Buildcontroller sich selbst offline genommen hat.
unavailable	Gibt an, dass der Buildcontroller nicht kontaktiert werden kann.

DataSourceBindingBase

Objekt

Stellt die Bindung der Datenquelle für die Serviceendpunktanforderung dar.

Name	Typ	Beschreibung
callbackContextTemplate	string	Paginierungsformat, das von dieser Datenquelle unterstützt wird(Fortsetzungstoken/SkipTop).
callbackRequiredTemplate	string	Nachfolgende Aufrufe sind erforderlich?
dataSourceName	string	Dient zum Abrufen oder Festlegen des Namens der Datenquelle.
endpointId	string	Ruft die Endpunkt-ID ab oder legt sie fest.
endpointUrl	string	Ruft die URL des Dienstendpunkts ab oder legt sie fest.
headers	AuthorizationHeader[]	Ruft die Autorisierungsheader ab oder legt sie fest.
initialContextTemplate	string	Definiert den Anfangswert der Abfrageparameter.
parameters	object	Ruft die Parameter für die Datenquelle ab oder legt sie fest.
requestContent	string	Dient zum Abrufen oder Festlegen des HTTP-Anforderungstexts.
requestVerb	string	Ruft das Http-Anforderungsverb ab oder legt es fest.
resultSelector	string	Ruft die Ergebnisauswahl ab oder legt sie fest.
resultTemplate	string	Ruft die Ergebnisvorlage ab oder legt sie fest.
target	string	Ruft ab oder legt das Ziel der Datenquelle fest.

DefinitionQuality

Enumeration

Die Qualität des Definitionsdokuments (Entwurf usw.)

Wert	Beschreibung
definition
draft

DefinitionQueueStatus

Enumeration

Ein Wert, der angibt, ob Builds für diese Definition in die Warteschlange gestellt werden können.

Wert	Beschreibung
disabled	Wenn die Definitionswarteschlange deaktiviert ist, können Builds nicht von Benutzern in die Warteschlange gestellt werden, und das System wird keine geplanten, gated- oder fortlaufenden Integrationsbuilds in die Warteschlange gestellt. Builds, die sich bereits in der Warteschlange befinden, werden nicht vom System gestartet.
enabled	Wenn die Definitionswarteschlange aktiviert ist, können Builds von Benutzern in die Warteschlange gestellt werden, werden vom System geplante, gated- und fortlaufende Integrationsbuilds in die Warteschlange eingereiht, und die Warteschlangenbuilds werden vom System gestartet.
paused	Wenn die Definitionswarteschlange angehalten wird, können Builds von Benutzern in die Warteschlange gestellt werden, und das System wird geplante, gated und fortlaufende Integrationsbuilds in die Warteschlange gestellt. Builds in der Warteschlange werden vom System nicht gestartet.

DefinitionReference

Objekt

Stellt einen Verweis auf eine Definition dar.

Name	Typ	Beschreibung
createdDate	string (date-time)	Das Datum, an dem diese Version der Definition erstellt wurde.
id	integer (int32)	Die ID der referenzierten Definition.
name	string	Der Name der referenzierten Definition.
path	string	Der Ordnerpfad der Definition.
project	TeamProjectReference	Ein Verweis auf das Projekt.
queueStatus	DefinitionQueueStatus	Ein Wert, der angibt, ob Builds für diese Definition in die Warteschlange gestellt werden können.
revision	integer (int32)	Die Revisionsnummer der Definition.
type	DefinitionType	Der Typ der Definition.
uri	string	Der URI der Definition.
url	string	Die REST-URL der Definition.

DefinitionTriggerType

Enumeration

Der Typ des Triggers.

Wert	Beschreibung
all	Alle Typen.
batchedContinuousIntegration	Ein Build sollte für mehrere Changeets gleichzeitig in einem bestimmten Intervall gestartet werden.
batchedGatedCheckIn	Für jeden Batch von Check-Ins sollte ein Überprüfungsbuild gestartet werden.
buildCompletion	Ein Build sollte ausgelöst werden, wenn ein anderer Build abgeschlossen ist.
continuousIntegration	Für jede Änderungsmenge sollte ein Build gestartet werden.
gatedCheckIn	Für jede Überprüfung sollte ein Überprüfungsbuild gestartet werden.
none	Nur manuelle Builds.
pullRequest	Ein Build sollte ausgelöst werden, wenn eine GitHub-Pullanforderung erstellt oder aktualisiert wird. In Ressourcenversion 3 hinzugefügt
schedule	Ein Build sollte in einem angegebenen Zeitplan gestartet werden, unabhängig davon, ob Änderungen vorhanden sind.

DefinitionType

Enumeration

Der Typ der Definition.

Wert	Beschreibung
build
xaml

Demand

Objekt

Stellt eine Anforderung dar, die von einer Definition oder einem Build verwendet wird.

Name	Typ	Beschreibung
name	string	Der Name der Funktion, auf die von der Anforderung verwiesen wird.
value	string	Der geforderte Wert.

IdentityRef

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Thema Diagramm. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Diagrammbetreff zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Diagrammbetreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird dasselbe Diagrammthema sowohl in Firmen als auch in Organisationen eindeutig identifiziert.
directoryAlias	string	Veraltet – Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im "Self"-Eintrag des IdentityRef -Wörterbuchs "_links" verwiesen wird
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammbetreffs. Um dieses Feld zu ändern, müssen Sie den Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet – Verfügbar im "Avatar"-Eintrag des IdentityRef-Wörterbuchs "_links"
inactive	boolean	Veraltet – Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.
isAadIdentity	boolean	Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Veraltet – nicht in den meisten bereits vorhandenen Implementierungen von ToIdentityRef verwendet
uniqueName	string	Veraltet – Verwenden Sie stattdessen "Domain+PrincipalName".
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

ProcessParameters

Objekt

Name	Typ	Beschreibung
dataSourceBindings	DataSourceBindingBase[]	Stellt die Bindung der Datenquelle für die Serviceendpunktanforderung dar.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectState

Enumeration

Projektstatus.

Wert	Beschreibung
all	Alle Projekte unabhängig vom Status außer "Gelöscht".
createPending	Projekt wurde zur Erstellung in die Warteschlange gestellt, aber der Prozess wurde noch nicht gestartet.
deleted	Projekt wurde gelöscht.
deleting	Project wird gerade gelöscht.
new	Projekt wird gerade erstellt.
unchanged	Projekt wurde nicht geändert.
wellFormed	Project wird vollständig erstellt und kann verwendet werden.

ProjectVisibility

Enumeration

Projektsichtbarkeit.

Wert	Beschreibung
private	Das Projekt ist nur für Benutzer mit expliziten Zugriff sichtbar.
public	Das Projekt ist für alle sichtbar.

PropertiesCollection

Objekt

Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger Typ mit einem TypeCode != TypeCode.Object) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

Name	Typ	Beschreibung
count	integer (int32)	Die Anzahl der Eigenschaften in der Auflistung.
item	object
keys	string[]	Der Satz von Schlüsseln in der Auflistung.
values	string[]	Der Wertesatz in der Auflistung.

QueueOptions

Enumeration

Zusätzliche Optionen für die Warteschlange des Builds.

Wert	Beschreibung
doNotRun	Erstellen sie eine Plan-ID für den Build, führen Sie sie nicht aus.
none	Keine Warteschlangenoptionen

QueuePriority

Enumeration

Die Priorität des Builds.

Wert	Beschreibung
aboveNormal	Über normaler Priorität.
belowNormal	Unter normaler Priorität.
high	Hohe Priorität.
low	Niedrige Priorität.
normal	Normale Priorität.

ReferenceLinks

Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

RetentionPolicy

Objekt

Stellt eine Aufbewahrungsrichtlinie für eine Builddefinition dar.

Name	Typ	Beschreibung
artifactTypesToDelete	string[]
artifacts	string[]
branches	string[]
daysToKeep	integer (int32)	Die Anzahl der Tage, die Builds beibehalten werden sollen.
deleteBuildRecord	boolean	Gibt an, ob der Builddatensatz selbst gelöscht werden soll.
deleteTestResults	boolean	Gibt an, ob Testergebnisse gelöscht werden sollen, die dem Build zugeordnet sind.
minimumToKeep	integer (int32)	Die Mindestanzahl der Builds, die beibehalten werden sollen.

TaskAgentPoolReference

Objekt

Stellt einen Verweis auf einen Agentpool dar.

Name	Typ	Beschreibung
id	integer (int32)	Die Pool-ID.
isHosted	boolean	Ein Wert, der angibt, ob dieser Pool vom Dienst verwaltet wird.
name	string	Der Poolname.

TaskInputDefinitionBase

Objekt

Name	Typ	Beschreibung
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

Name	Typ	Beschreibung
expression	string	Bedingter Ausdruck
message	string	Meldung, in der erläutert wird, wie der Benutzer korrigieren kann, wenn die Überprüfung fehlschlägt

TaskOrchestrationPlanReference

Objekt

Stellt einen Verweis auf einen Orchestrierungsplan dar.

Name	Typ	Beschreibung
orchestrationType	integer (int32)	Der Typ des Plans.
planId	string (uuid)	Die ID des Plans.

TaskSourceDefinitionBase

Objekt

Name	Typ	Beschreibung
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

TeamProjectReference

Objekt

Stellt einen flachen Verweis auf ein TeamProject dar.

Name	Typ	Beschreibung
abbreviation	string	Projektkürzel.
defaultTeamImageUrl	string	Url zum standardmäßigen Teamidentitätsbild.
description	string	Die Beschreibung des Projekts (falls vorhanden).
id	string (uuid)	Projektbezeichner.
lastUpdateTime	string (date-time)	Zeitpunkt der letzten Aktualisierung des Projekts.
name	string	Projektname.
revision	integer (int64)	Projektrevision.
state	ProjectState	Projektstatus.
url	string	Die URL zur Vollversion des Objekts.
visibility	ProjectVisibility	Projektsichtbarkeit.

ValidationResult

Enumeration

Das Ergebnis.

Wert	Beschreibung
error
ok
warning

VariableGroup

Objekt

Stellt eine Variablegruppe dar.

Name	Typ	Beschreibung
alias	string	Der Name der Variablengruppe.
description	string	Die Beschreibung.
id	integer (int32)	Die ID der Variablengruppe.
name	string	Der Name der Variablengruppe.
type	string	Der Typ der Variablengruppe.
variables	<string,  BuildDefinitionVariable>