Freigeben über


Templates - List

Ruft alle Definitionsvorlagen ab.

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

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

api-version
query True

string

Version der zu verwendenden API. Diese sollte auf 6.0 festgelegt werden, um diese Version der API zu verwenden.

Antworten

Name Typ Beschreibung
200 OK

BuildDefinitionTemplate[]

Erfolgreicher Vorgang

Sicherheit

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Beschreibung
vso.build Ermöglicht den Zugriff auf Buildartefakte, einschließlich Buildergebnissen, Definitionen und Anforderungen, und die Möglichkeit, Benachrichtigungen über Buildereignisse über Diensthaken zu empfangen.

Definitionen

Name Beschreibung
AgentPoolQueue

Stellt eine Warteschlange zum Ausführen von Builds dar.

AgentSpecification

Spezifikation des vom Poolanbieter definierten Agents.

AuthorizationHeader
Build

Datendarstellung eines Builds.

BuildAuthorizationScope

Der Auftragsautorisierungsbereich für Builds, die für diese 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 auf 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 Build-status.

BuildTrigger

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

ControllerStatus

Die status des Verantwortlichen.

DataSourceBindingBase

Stellt die Bindung der Datenquelle für die Dienstendpunktanforderung 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üssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) außer für DBNull werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

QueueOptions

Zusätzliche Optionen für die Warteschlange für den Build.

QueuePriority

Die Priorität des Builds.

ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks 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 Variablengruppe dar.

AgentPoolQueue

Stellt eine Warteschlange zum Ausführen von Builds dar.

Name Typ Beschreibung
_links

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

id

integer

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

Spezifikation des vom Poolanbieter definierten Agents.

Name Typ Beschreibung
identifier

string

Eindeutiger Bezeichner der Agentspezifikation.

AuthorizationHeader

Name Typ Beschreibung
name

string

value

string

Build

Datendarstellung eines Builds.

Name Typ Beschreibung
_links

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

agentSpecification

AgentSpecification

Die Agentspezifikation für den Build.

buildNumber

string

Die Buildnummer/der Name des Builds.

buildNumberRevision

integer

Die Buildnummerrevision.

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, die den Build gelöscht hat.

deletedDate

string

Das Datum, an dem der Build gelöscht wurde.

deletedReason

string

Die Beschreibung, wie der Build gelöscht wurde.

demands

Demand[]

Eine Liste von Anforderungen, die die für diesen Build erforderlichen Agent-Funktionen darstellt.

finishTime

string

Der Zeitpunkt, zu dem der Build abgeschlossen wurde.

id

integer

Die ID des Builds.

keepForever

boolean

Gibt an, ob der Build von Aufbewahrungsrichtlinien übersprungen werden soll.

lastChangedBy

IdentityRef

Die Identität, die den Prozess oder die Person darstellt, die den Build zuletzt geändert hat.

lastChangedDate

string

Das Datum, an dem der Build zuletzt geändert wurde.

logs

BuildLogReference

Informationen zu den Buildprotokollen.

orchestrationPlan

TaskOrchestrationPlanReference

Der Orchestrierungsplan für den Build.

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üssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder 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 String umgestimmt. 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.

queueOptions

QueueOptions

Zusätzliche Optionen für die Warteschlange für den Build.

queuePosition

integer

Die aktuelle Position des Builds in der Warteschlange.

queueTime

string

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, für deren Namen der Build in die Warteschlange gestellt wurde.

result

BuildResult

Das Buildergebnis.

retainedByRelease

boolean

Gibt an, ob der Build von einem Release beibehalten wird.

sourceBranch

string

Der Quellbranch.

sourceVersion

string

Die Quellversion.

startTime

string

Der Zeitpunkt, zu dem der Build gestartet wurde.

status

BuildStatus

Der Status des Builds.

tags

string[]

triggerInfo

object

Quellenanbieterspezifische 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

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

Name Typ Beschreibung
project

string

Die verwendete Identität sollte über Builddienstberechtigungen verfügen, die für das Projekt gelten, in dem sich die Builddefinition befindet. Dies ist nützlich für die Isolation von Buildaufträgen für ein bestimmtes Teamprojekt, um unbeabsichtigte Eskalationen von Berechtigungsangriffen während eines Builds zu vermeiden.

projectCollection

string

Die verwendete Identität sollte über Builddienstberechtigungen verfügen, die auf die Projektsammlung ausgerichtet sind. Dies ist nützlich, wenn Ressourcen für einen einzelnen Build auf mehrere Projekte verteilt sind.

BuildController

Name Typ Beschreibung
_links

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

createdDate

string

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

ID der Ressource

name

string

Name der verknüpften Ressource (Definitionsname, Controllername usw.)

status

ControllerStatus

Die status des Verantwortlichen.

updatedDate

string

Das Datum, an dem der Controller zuletzt aktualisiert wurde.

uri

string

Der URI des Controllers.

url

string

Vollständiger HTTP-Link zur Ressource

BuildDefinition

Stellt eine Builddefinition dar.

Name Typ Beschreibung
_links

ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks 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 Zeitsparkommentar für die Definition.

createdDate

string

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, von der diese Definition ein Entwurf ist, wenn es sich um einen Entwurf einer Definition handelt.

drafts

DefinitionReference[]

Die Liste der Entwürfe, die dieser Definition zugeordnet sind, wenn es sich nicht um eine Entwurfsdefinition handelt.

dropLocation

string

Der Speicherort für die Definition.

id

integer

Die ID der Definition, auf die verwiesen wird.

jobAuthorizationScope

BuildAuthorizationScope

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

jobCancelTimeoutInMinutes

integer

Das Timeout für den Abbruch des Auftrags (in Minuten) für Builds, die vom Benutzer für diese Definition abgebrochen wurden.

jobTimeoutInMinutes

integer

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 Definition, auf die verwiesen wird.

options

BuildOption[]

Stellt die Anwendung eines optionalen Verhaltens auf 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üssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) außer für DBNull werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. 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

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 Variablengruppe dar.

variables

<string,  BuildDefinitionVariable>

BuildDefinitionTemplate

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

Die ID der Aufgabe, deren Symbol verwendet wird, wenn diese Vorlage auf der Benutzeroberfläche angezeigt wird.

icons

object

id

string

Die ID der Vorlage.

name

string

Der Name der Vorlage.

template

BuildDefinition

Die eigentliche Vorlage.

BuildDefinitionVariable

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 Geheimnis ist.

value

string

Der Wert der Variablen.

BuildLogReference

Stellt einen Verweis auf ein Buildprotokoll dar.

Name Typ Beschreibung
id

integer

Die ID des Protokolls.

type

string

Der Typ des Protokollspeicherorts.

url

string

Ein vollständiger Link zur Protokollressource.

BuildMetric

Stellt Metadaten zu Builds im System dar.

Name Typ Beschreibung
date

string

Das Datum für den Bereich.

intValue

integer

Der Wert.

name

string

Der Name der Metrik.

scope

string

Der Bereich.

BuildOption

Stellt die Anwendung eines optionalen Verhaltens auf 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

Stellt einen Verweis auf eine Buildoptionsdefinition dar.

Name Typ Beschreibung
id

string

Die ID der Buildoption, auf die verwiesen wird.

BuildProcess

Stellt einen Buildprozess dar.

Name Typ Beschreibung
type

integer

Der Typ der Verarbeitung.

BuildReason

Der Grund, warum der Build erstellt wurde.

Name Typ Beschreibung
all

string

Alle Gründe.

batchedCI

string

Der Build wurde für den Trigger TriggerType.BatchedContinuousIntegration gestartet.

buildCompletion

string

Der Build wurde gestartet, als ein anderer Build abgeschlossen wurde.

checkInShelveset

string

Der Build wurde für den Trigger ContinuousIntegrationType.Gated gestartet.

individualCI

string

Der Build wurde für den Trigger TriggerType.ContinuousIntegration gestartet.

manual

string

Der Build wurde manuell gestartet.

none

string

Kein Grund. Dieser Wert sollte nicht verwendet werden.

pullRequest

string

Der Build wurde durch einen Pull Request gestartet. In Ressourcenversion 3 hinzugefügt.

resourceTrigger

string

Der Build wurde gestartet, als Ressourcen in der Pipeline ihn ausgelöst haben.

schedule

string

Der Build wurde für den Trigger TriggerType.Schedule gestartet.

scheduleForced

string

Der Build wurde für den Trigger TriggerType.ScheduleForced gestartet.

triggered

string

Der Build wurde zu Aufbewahrungsrichtlinienzwecken ausgelöst.

userCreated

string

Der Build wurde von einem Benutzer erstellt.

validateShelveset

string

Der Build wurde für die private Validierung manuell gestartet.

BuildRepository

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

Name Typ Beschreibung
checkoutSubmodules

boolean

Gibt an, ob Untermodule auscheckt werden sollen.

clean

string

Gibt an, ob der Zielordner beim Abrufen von Code aus dem Repository sauber werden soll.

defaultBranch

string

Der Name des Standardbranch.

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

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

Das Buildergebnis.

Name Typ Beschreibung
canceled

string

Der Build wurde vor dem Start abgebrochen.

failed

string

Der Build wurde nicht erfolgreich abgeschlossen.

none

string

Kein Ergebnis

partiallySucceeded

string

Die Kompilierung wurde erfolgreich abgeschlossen, es gab jedoch andere Fehler.

succeeded

string

Der Build wurde erfolgreich abgeschlossen.

BuildStatus

Der Build-status.

Name Typ Beschreibung
all

string

Gesamtstatus.

cancelling

string

Der Build wird abgebrochen.

completed

string

Der Build wurde abgeschlossen.

inProgress

string

Der Build wird derzeit ausgeführt.

none

string

Kein Status.

notStarted

string

Der Build wurde noch nicht gestartet.

postponed

string

Der Build ist in der Warteschlange inaktiv.

BuildTrigger

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

Name Typ Beschreibung
triggerType

DefinitionTriggerType

Der Typ des Triggers.

ControllerStatus

Die status des Verantwortlichen.

Name Typ Beschreibung
available

string

Gibt an, dass der Buildcontroller derzeit verfügbar ist.

offline

string

Gibt an, dass der Buildcontroller sich selbst offline geschaltet hat.

unavailable

string

Gibt an, dass der Buildcontroller nicht kontaktiert werden kann.

DataSourceBindingBase

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

Name Typ Beschreibung
callbackContextTemplate

string

Paginierungsformat, das von dieser Datenquelle unterstützt wird (ContinuationToken/SkipTop).

callbackRequiredTemplate

string

Nachfolgende Aufrufe erforderlich?

dataSourceName

string

Ruft den Namen der Datenquelle ab oder legt den Namen fest.

endpointId

string

Ruft die Endpunkt-ID ab oder legt diese fest.

endpointUrl

string

Ruft die URL des Dienstendpunkts ab oder legt sie fest.

headers

AuthorizationHeader[]

Ruft die Autorisierungsheader ab oder legt diese fest.

initialContextTemplate

string

Definiert den Anfangswert der Abfrageparameter

parameters

object

Ruft die Parameter für die Datenquelle ab oder legt sie fest.

requestContent

string

Ruft http-Anforderungstext ab oder legt den Text fest

requestVerb

string

Ruft http-Anforderungsverb ab oder legt es fest

resultSelector

string

Ruft den Ergebnisauswahlor ab oder legt diese fest.

resultTemplate

string

Ruft die Ergebnisvorlage ab oder legt sie fest.

target

string

Ruft das Ziel der Datenquelle ab oder legt es fest.

DefinitionQuality

Die Qualität des Definitionsdokuments (Entwurf usw.)

Name Typ Beschreibung
definition

string

draft

string

DefinitionQueueStatus

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

Name Typ Beschreibung
disabled

string

Wenn die Definitionswarteschlange deaktiviert ist, können Builds nicht von Benutzern in die Warteschlange eingereiht werden, und das System führt keine geplanten, gated- oder Continuous Integration-Builds durch das System. Builds, die sich bereits in der Warteschlange befinden, werden vom System nicht gestartet.

enabled

string

Wenn die Definitionswarteschlange aktiviert ist, können Builds von Benutzern in die Warteschlange eingereiht werden, werden vom System geplante, gated- und Continuous Integration-Builds in die Warteschlange eingereiht, und die Builds in der Warteschlange werden vom System gestartet.

paused

string

Wenn die Definitionswarteschlange angehalten wird, können Builds von Benutzern in die Warteschlange eingereiht werden, und das System führt geplante, gated und Continuous Integration-Builds in die Warteschlange ein. Builds in der Warteschlange werden vom System nicht gestartet.

DefinitionReference

Stellt einen Verweis auf eine Definition dar.

Name Typ Beschreibung
createdDate

string

Das Datum, an dem diese Version der Definition erstellt wurde.

id

integer

Die ID der Definition, auf die verwiesen wird.

name

string

Der Name der Definition, auf die verwiesen wird.

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

Die Nummer der Definitionsrevision.

type

DefinitionType

Der Typ der Definition.

uri

string

Der URI der Definition.

url

string

Die REST-URL der Definition.

DefinitionTriggerType

Der Typ des Triggers.

Name Typ Beschreibung
all

string

Alle Typen.

batchedContinuousIntegration

string

Ein Build sollte für mehrere Changesets gleichzeitig in einem angegebenen Intervall gestartet werden.

batchedGatedCheckIn

string

Für jeden Batch von Check-Ins sollte ein Validierungsbuild gestartet werden.

buildCompletion

string

Ein Build sollte ausgelöst werden, wenn ein anderer Build abgeschlossen ist.

continuousIntegration

string

Für jedes Changeset sollte ein Build gestartet werden.

gatedCheckIn

string

Für jeden Check-In sollte ein Validierungsbuild gestartet werden.

none

string

Nur manuelle Builds.

pullRequest

string

Ein Build sollte ausgelöst werden, wenn ein GitHub-Pull Request erstellt oder aktualisiert wird. Hinzugefügt in Ressourcenversion 3

schedule

string

Ein Build sollte nach einem angegebenen Zeitplan gestartet werden, unabhängig davon, ob Changesets vorhanden sind oder nicht.

DefinitionType

Der Typ der Definition.

Name Typ Beschreibung
build

string

xaml

string

Demand

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

Name Typ Beschreibung
_links

ReferenceLinks

Dieses Feld enthält null oder interessantere Links zum Diagrammthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graph-Thema zu erhalten.

descriptor

string

Der Deskriptor ist die primäre Möglichkeit, auf den Graphengegenstand zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.

directoryAlias

string

Veraltet: Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im Eintrag "selbst" des IdentityRef-Wörterbuchs "_links" verwiesen wird.

displayName

string

Dies ist der nicht eindeutige Anzeigename des Diagrammsubjekts. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.

id

string

imageUrl

string

Veraltet: Verfügbar im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links"

inactive

boolean

Veraltet: Kann durch Abfragen des Graph-Mitgliedschaftsstatus abgerufen werden, 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: Wird in den meisten bereits vorhandenen Implementierungen von ToIdentityRef nicht verwendet.

uniqueName

string

Veraltet: Verwenden Sie stattdessen Domain+PrincipalName.

url

string

Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

ProcessParameters

Name Typ Beschreibung
dataSourceBindings

DataSourceBindingBase[]

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

inputs

TaskInputDefinitionBase[]

sourceDefinitions

TaskSourceDefinitionBase[]

ProjectState

Projektstatus.

Name Typ Beschreibung
all

string

Alle Projekte unabhängig vom Zustand.

createPending

string

Project wurde für die Erstellung in die Warteschlange gestellt, aber der Prozess wurde noch nicht gestartet.

deleted

string

Project wurde gelöscht.

deleting

string

Project wird gerade gelöscht.

new

string

Das Projekt wird gerade erstellt.

unchanged

string

Project wurde nicht geändert.

wellFormed

string

Project ist vollständig erstellt und einsatzbereit.

ProjectVisibility

Projektsichtbarkeit.

Name Typ Beschreibung
private

string

Das Projekt ist nur für Benutzer mit explizitem Zugriff sichtbar.

public

string

Das Projekt ist für alle sichtbar.

PropertiesCollection

Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) außer für DBNull werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

Name Typ Beschreibung
count

integer

Die Anzahl der Eigenschaften in der Auflistung.

item

object

keys

string[]

Der Satz von Schlüsseln in der Auflistung.

values

string[]

Der Satz von Werten in der Auflistung.

QueueOptions

Zusätzliche Optionen für die Warteschlange für den Build.

Name Typ Beschreibung
doNotRun

string

Erstellen Sie eine Plan-ID für den Build, und führen Sie ihn nicht aus.

none

string

Keine Warteschlangenoptionen

QueuePriority

Die Priorität des Builds.

Name Typ Beschreibung
aboveNormal

string

Über der normalen Priorität.

belowNormal

string

Unterhalb der normalen Priorität.

high

string

Hohe Priorität.

low

string

Niedrige Priorität.

normal

string

Normale Priorität.

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

RetentionPolicy

Stellt eine Aufbewahrungsrichtlinie für eine Builddefinition dar.

Name Typ Beschreibung
artifactTypesToDelete

string[]

artifacts

string[]

branches

string[]

daysToKeep

integer

Die Anzahl der Tage, für die Builds beibehalten werden sollen.

deleteBuildRecord

boolean

Gibt an, ob der Builddatensatz selbst gelöscht werden soll.

deleteTestResults

boolean

Gibt an, ob testergebnisse, die dem Build zugeordnet sind, gelöscht werden sollen.

minimumToKeep

integer

Die mindeste Anzahl von Builds, die beibehalten werden sollen.

TaskAgentPoolReference

Stellt einen Verweis auf einen Agentpool dar.

Name Typ Beschreibung
id

integer

Die Pool-ID.

isHosted

boolean

Ein Wert, der angibt, ob dieser Pool vom Dienst verwaltet wird oder nicht.

name

string

Der Poolname.

TaskInputDefinitionBase

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

Name Typ Beschreibung
expression

string

Bedingter Ausdruck

message

string

Meldung, in der erläutert wird, wie benutzer korrigieren kann, wenn die Überprüfung fehlschlägt

TaskOrchestrationPlanReference

Stellt einen Verweis auf einen Orchestrierungsplan dar.

Name Typ Beschreibung
orchestrationType

integer

Der Typ des Plans.

planId

string

Die ID des Plans.

TaskSourceDefinitionBase

Name Typ Beschreibung
authKey

string

endpoint

string

keySelector

string

selector

string

target

string

TeamProjectReference

Stellt einen flachen Verweis auf ein TeamProject dar.

Name Typ Beschreibung
abbreviation

string

Projektkürzel.

defaultTeamImageUrl

string

URL zum Standardmäßigen Teamidentitätsimage.

description

string

Die Projektbeschreibung (falls vorhanden).

id

string

Projektbezeichner.

lastUpdateTime

string

Zeitpunkt der letzten Aktualisierung des Projekts.

name

string

Der Projektname.

revision

integer

Projektrevision.

state

ProjectState

Projektstatus.

url

string

URL zur Vollversion des Objekts.

visibility

ProjectVisibility

Projektsichtbarkeit.

ValidationResult

Das Ergebnis.

Name Typ Beschreibung
error

string

ok

string

warning

string

VariableGroup

Stellt eine Variablengruppe dar.

Name Typ Beschreibung
alias

string

Der Name der Variablengruppe.

description

string

Die Beschreibung.

id

integer

Die ID der Variablengruppe.

name

string

Der Name der Variablengruppe.

type

string

Der Typ der Variablengruppe.

variables

<string,  BuildDefinitionVariable>