Freigeben über


Builds - Get

Ruft einen Build ab.

GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}?api-version=7.1-preview.7
GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}?propertyFilters={propertyFilters}&api-version=7.1-preview.7

URI-Parameter

Name In Erforderlich Typ Beschreibung
buildId
path True

integer

int32
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. Dies sollte auf "7.1-preview.7" festgelegt werden, um diese Version der API zu verwenden.

propertyFilters
query

string

Antworten

Name Typ Beschreibung
200 OK

Build

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, sowie die Möglichkeit, Benachrichtigungen über Buildereignisse über Diensthooks zu empfangen.

Definitionen

Name Beschreibung
AgentPoolQueue

Stellt eine Warteschlange zum Ausführen von Builds dar.

AgentSpecification

Spezifikation des vom Poolanbieter definierten Agents.

Build

Datendarstellung eines Builds.

BuildController
BuildLogReference

Stellt einen Verweis auf ein Buildprotokoll 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.

ControllerStatus

Die status des Verantwortlichen.

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.

DefinitionType

Der Typ der Definition.

Demand

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

IdentityRef
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) 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.

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.

TaskAgentPoolReference

Stellt einen Verweis auf einen Agentpool dar.

TaskOrchestrationPlanReference

Stellt einen Verweis auf einen Orchestrierungsplan dar.

TeamProjectReference

Stellt einen flachen Verweis auf ein TeamProject dar.

ValidationResult

Das Ergebnis.

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.

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.

appendCommitMessageToRunName

boolean

Fügen Sie eine Commitnachricht an BuildNumber in der Benutzeroberfläche an.

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.

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. WARNUNG: Dieses Feld ist veraltet und entspricht nicht den Auftragswarteschlangen.

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[]

templateParameters

object

Parameter für die Auswertung von Vorlagenausdrucken

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.

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

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.

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 auschecken 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.

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.

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.

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.

ProjectState

Projektstatus.

Name Typ Beschreibung
all

string

Alle Projekte unabhängig vom Zustand mit Ausnahme von "Gelöscht".

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) 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.

Name Typ Beschreibung
count

integer

Die Anzahl der Eigenschaften in der Auflistung.

item

object

keys

string[]

Der Schlüsselsatz in der Auflistung.

values

string[]

Der Wertsatz 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ützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

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.

name

string

Der Poolname.

TaskOrchestrationPlanReference

Stellt einen Verweis auf einen Orchestrierungsplan dar.

Name Typ Beschreibung
orchestrationType

integer

Der Typ des Plans.

planId

string

Die ID des Plans.

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