Interface Build

Data representation of a build.

interface Build {
    _links?: any;
    agentSpecification?: AgentSpecification;
    appendCommitMessageToRunName?: boolean;
    buildNumber?: string;
    buildNumberRevision?: number;
    controller?: BuildController;
    definition?: DefinitionReference;
    deleted?: boolean;
    deletedBy?: IdentityRef;
    deletedDate?: Date;
    deletedReason?: string;
    demands?: Demand[];
    finishTime?: Date;
    id?: number;
    keepForever?: boolean;
    lastChangedBy?: IdentityRef;
    lastChangedDate?: Date;
    logs?: BuildLogReference;
    orchestrationPlan?: TaskOrchestrationPlanReference;
    parameters?: string;
    plans?: TaskOrchestrationPlanReference[];
    priority?: QueuePriority;
    project?: TeamProjectReference;
    properties?: any;
    quality?: string;
    queue?: AgentPoolQueue;
    queueOptions?: QueueOptions;
    queuePosition?: number;
    queueTime?: Date;
    reason?: BuildReason;
    repository?: BuildRepository;
    requestedBy?: IdentityRef;
    requestedFor?: IdentityRef;
    result?: BuildResult;
    retainedByRelease?: boolean;
    sourceBranch?: string;
    sourceVersion?: string;
    startTime?: Date;
    status?: BuildStatus;
    tags?: string[];
    templateParameters?: { [key: string]: string };
    triggeredByBuild?: Build;
    triggerInfo?: { [key: string]: string };
    uri?: string;
    url?: string;
    validationResults?: BuildRequestValidationResult[];
}

Properties

_links? agentSpecification? appendCommitMessageToRunName? buildNumber? buildNumberRevision? controller? definition? deleted? deletedBy? deletedDate? deletedReason? demands? finishTime? id? keepForever? lastChangedBy? lastChangedDate? logs? orchestrationPlan? parameters? plans? priority? project? properties? quality? queue? queueOptions? queuePosition? queueTime? reason? repository? requestedBy? requestedFor? result? retainedByRelease? sourceBranch? sourceVersion? startTime? status? tags? templateParameters? triggeredByBuild? triggerInfo? uri? url? validationResults?

Properties

Optional_links

_links?: any

OptionalagentSpecification

agentSpecification?: AgentSpecification

The agent specification for the build.

OptionalappendCommitMessageToRunName

appendCommitMessageToRunName?: boolean

Append Commit Message To BuildNumber in UI.

OptionalbuildNumber

buildNumber?: string

The build number/name of the build.

OptionalbuildNumberRevision

buildNumberRevision?: number

The build number revision.

Optionalcontroller

controller?: BuildController

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

Optionaldefinition

definition?: DefinitionReference

The definition associated with the build.

Optionaldeleted

deleted?: boolean

Indicates whether the build has been deleted.

OptionaldeletedBy

deletedBy?: IdentityRef

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

OptionaldeletedDate

deletedDate?: Date

The date the build was deleted.

OptionaldeletedReason

deletedReason?: string

The description of how the build was deleted.

Optionaldemands

demands?: Demand[]

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

OptionalfinishTime

finishTime?: Date

The time that the build was completed.

Optionalid

id?: number

The ID of the build.

OptionalkeepForever

keepForever?: boolean

Indicates whether the build should be skipped by retention policies.

OptionallastChangedBy

lastChangedBy?: IdentityRef

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

OptionallastChangedDate

lastChangedDate?: Date

The date the build was last changed.

Optionallogs

logs?: BuildLogReference

Information about the build logs.

OptionalorchestrationPlan

orchestrationPlan?: TaskOrchestrationPlanReference

The orchestration plan for the build.

Optionalparameters

parameters?: string

The parameters for the build.

Optionalplans

plans?: TaskOrchestrationPlanReference[]

Orchestration plans associated with the build (build, cleanup)

Optionalpriority

priority?: QueuePriority

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

Optionalproject

project?: TeamProjectReference

The team project.

Optionalproperties

properties?: any

Optionalquality

quality?: string

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

Optionalqueue

queue?: AgentPoolQueue

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.

OptionalqueueOptions

queueOptions?: QueueOptions

Additional options for queueing the build.

OptionalqueuePosition

queuePosition?: number

The current position of the build in the queue.

OptionalqueueTime

queueTime?: Date

The time that the build was queued.

Optionalreason

reason?: BuildReason

The reason that the build was created.

Optionalrepository

repository?: BuildRepository

The repository.

OptionalrequestedBy

requestedBy?: IdentityRef

The identity that queued the build.

OptionalrequestedFor

requestedFor?: IdentityRef

The identity on whose behalf the build was queued.

Optionalresult

result?: BuildResult

The build result.

OptionalretainedByRelease

retainedByRelease?: boolean

Indicates whether the build is retained by a release.

OptionalsourceBranch

sourceBranch?: string

The source branch.

OptionalsourceVersion

sourceVersion?: string

The source version.

OptionalstartTime

startTime?: Date

The time that the build was started.

Optionalstatus

status?: BuildStatus

The status of the build.

Optionaltags

tags?: string[]

OptionaltemplateParameters

templateParameters?: { [key: string]: string }

Parameters to template expression evaluation

OptionaltriggeredByBuild

triggeredByBuild?: Build

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

OptionaltriggerInfo

triggerInfo?: { [key: string]: string }

Sourceprovider-specific information about what triggered the build

Optionaluri

uri?: string

The URI of the build.

Optionalurl

url?: string

The REST URL of the build.

OptionalvalidationResults

validationResults?: BuildRequestValidationResult[]

Settings

Member Visibility

On This Page

Properties