Build interface

Package:

azure-devops-extension-api

Data representation of a build.

Properties

agentSpecification	The agent specification for the build.
appendCommitMessageToRunName	Append Commit Message To BuildNumber in UI.
buildNumber	The build number/name of the build.
buildNumberRevision	The build number revision.
controller	The build controller. This is only set if the definition type is Xaml.
definition	The definition associated with the build.
deleted	Indicates whether the build has been deleted.
deletedBy	The identity of the process or person that deleted the build.
deletedDate	The date the build was deleted.
deletedReason	The description of how the build was deleted.
demands	A list of demands that represents the agent capabilities required by this build.
finishTime	The time that the build was completed.
id	The ID of the build.
keepForever	Indicates whether the build should be skipped by retention policies.
lastChangedBy	The identity representing the process or person that last changed the build.
lastChangedDate	The date the build was last changed.
logs	Information about the build logs.
orchestrationPlan	The orchestration plan for the build.
parameters	The parameters for the build.
plans	Orchestration plans associated with the build (build, cleanup)
priority	Azure Pipelines does not support job priority. This field is deprecated.
project	The team project.
properties
quality	The quality of the xaml build (good, bad, etc.)
queue	The queue. This is only set if the definition type is Build. WARNING: this field is deprecated and does not corresponds to the jobs queues.
queueOptions	Additional options for queueing the build.
queuePosition	The current position of the build in the queue.
queueTime	The time that the build was queued.
reason	The reason that the build was created.
repository	The repository.
requestedBy	The identity that queued the build.
requestedFor	The identity on whose behalf the build was queued.
result	The build result.
retainedByRelease	Indicates whether the build is retained by a release.
sourceBranch	The source branch.
sourceVersion	The source version.
startTime	The time that the build was started.
status	The status of the build.
tags
templateParameters	Parameters to template expression evaluation
triggeredByBuild	The build that triggered this build via a Build completion trigger.
triggerInfo	Sourceprovider-specific information about what triggered the build
uri	The URI of the build.
url	The REST URL of the build.
validationResults

Property Details

agentSpecification

The agent specification for the build.

agentSpecification: AgentSpecification

Property Value

AgentSpecification

appendCommitMessageToRunName

Append Commit Message To BuildNumber in UI.

appendCommitMessageToRunName: boolean

Property Value

boolean

buildNumber

The build number/name of the build.

buildNumber: string

Property Value

string

buildNumberRevision

The build number revision.

buildNumberRevision: number

Property Value

number

controller

The build controller. This is only set if the definition type is Xaml.

controller: BuildController

Property Value

BuildController

definition

The definition associated with the build.

definition: DefinitionReference

Property Value

DefinitionReference

deleted

Indicates whether the build has been deleted.

deleted: boolean

Property Value

boolean

deletedBy

The identity of the process or person that deleted the build.

deletedBy: IdentityRef

Property Value

IdentityRef

deletedDate

The date the build was deleted.

deletedDate: Date

Property Value

Date

deletedReason

The description of how the build was deleted.

deletedReason: string

Property Value

string

demands

A list of demands that represents the agent capabilities required by this build.

demands: Demand[]

Property Value

Demand[]

finishTime

The time that the build was completed.

finishTime: Date

Property Value

Date

id

The ID of the build.

id: number

Property Value

number

keepForever

Indicates whether the build should be skipped by retention policies.

keepForever: boolean

Property Value

boolean

lastChangedBy

The identity representing the process or person that last changed the build.

lastChangedBy: IdentityRef

Property Value

IdentityRef

lastChangedDate

The date the build was last changed.

lastChangedDate: Date

Property Value

Date

logs

Information about the build logs.

logs: BuildLogReference

Property Value

BuildLogReference

orchestrationPlan

The orchestration plan for the build.

orchestrationPlan: TaskOrchestrationPlanReference

Property Value

TaskOrchestrationPlanReference

parameters

The parameters for the build.

parameters: string

Property Value

string

plans

Orchestration plans associated with the build (build, cleanup)

plans: TaskOrchestrationPlanReference[]

Property Value

TaskOrchestrationPlanReference[]

priority

Azure Pipelines does not support job priority. This field is deprecated.

priority: QueuePriority

Property Value

QueuePriority

project

The team project.

project: TeamProjectReference

Property Value

TeamProjectReference

properties

properties: any

Property Value

any

quality

The quality of the xaml build (good, bad, etc.)

quality: string

Property Value

string

queue

The queue. This is only set if the definition type is Build. WARNING: this field is deprecated and does not corresponds to the jobs queues.

queue: AgentPoolQueue

Property Value

AgentPoolQueue

queueOptions

Additional options for queueing the build.

queueOptions: QueueOptions

Property Value

QueueOptions

queuePosition

The current position of the build in the queue.

queuePosition: number

Property Value

number

queueTime

The time that the build was queued.

queueTime: Date

Property Value

Date

reason

The reason that the build was created.

reason: BuildReason

Property Value

BuildReason

repository

The repository.

repository: BuildRepository

Property Value

BuildRepository

requestedBy

The identity that queued the build.

requestedBy: IdentityRef

Property Value

IdentityRef

requestedFor

The identity on whose behalf the build was queued.

requestedFor: IdentityRef

Property Value

IdentityRef

result

The build result.

result: BuildResult

Property Value

BuildResult

retainedByRelease

Indicates whether the build is retained by a release.

retainedByRelease: boolean

Property Value

boolean

sourceBranch

The source branch.

sourceBranch: string

Property Value

string

sourceVersion

The source version.

sourceVersion: string

Property Value

string

startTime

The time that the build was started.

startTime: Date

Property Value

Date

status

The status of the build.

status: BuildStatus

Property Value

BuildStatus

tags

tags: string[]

Property Value

string[]

templateParameters

Parameters to template expression evaluation

templateParameters: {[key: string]: string}

Property Value

{[key: string]: string}

triggeredByBuild

The build that triggered this build via a Build completion trigger.

triggeredByBuild: Build

Property Value

Build

triggerInfo

Sourceprovider-specific information about what triggered the build

triggerInfo: {[key: string]: string}

Property Value

{[key: string]: string}

uri

The URI of the build.

uri: string

Property Value

string

url

The REST URL of the build.

url: string

Property Value

string

validationResults

validationResults: BuildRequestValidationResult[]

Property Value

BuildRequestValidationResult[]