Interface BuildDefinition

Represents a build definition.

interface BuildDefinition {
    _links?: any;
    authoredBy?: IdentityRef;
    badgeEnabled?: boolean;
    buildNumberFormat?: string;
    comment?: string;
    createdDate?: Date;
    demands?: Demand[];
    description?: string;
    draftOf?: DefinitionReference;
    drafts?: DefinitionReference[];
    dropLocation?: string;
    id?: number;
    jobAuthorizationScope?: BuildAuthorizationScope;
    jobCancelTimeoutInMinutes?: number;
    jobTimeoutInMinutes?: number;
    latestBuild?: Build;
    latestCompletedBuild?: Build;
    metrics?: BuildMetric[];
    name?: string;
    options?: BuildOption[];
    path?: string;
    process?: BuildProcess;
    processParameters?: ProcessParameters;
    project?: TeamProjectReference;
    properties?: any;
    quality?: DefinitionQuality;
    queue?: AgentPoolQueue;
    queueStatus?: DefinitionQueueStatus;
    repository?: BuildRepository;
    retentionRules?: RetentionPolicy[];
    revision?: number;
    tags?: string[];
    triggers?: BuildTrigger[];
    type?: DefinitionType;
    uri?: string;
    url?: string;
    variableGroups?: VariableGroup[];
    variables?: { [key: string]: BuildDefinitionVariable };
}

Hierarchy (View Summary)

Properties

_links? authoredBy? badgeEnabled? buildNumberFormat? comment? createdDate? demands? description? draftOf? drafts? dropLocation? id? jobAuthorizationScope? jobCancelTimeoutInMinutes? jobTimeoutInMinutes? latestBuild? latestCompletedBuild? metrics? name? options? path? process? processParameters? project? properties? quality? queue? queueStatus? repository? retentionRules? revision? tags? triggers? type? uri? url? variableGroups? variables?

Properties

Optional_links

_links?: any

OptionalauthoredBy

authoredBy?: IdentityRef

The author of the definition.

OptionalbadgeEnabled

badgeEnabled?: boolean

Indicates whether badges are enabled for this definition.

OptionalbuildNumberFormat

buildNumberFormat?: string

The build number format.

Optionalcomment

comment?: string

A save-time comment for the definition.

OptionalcreatedDate

createdDate?: Date

The date this version of the definition was created.

Optionaldemands

demands?: Demand[]

Optionaldescription

description?: string

The description.

OptionaldraftOf

draftOf?: DefinitionReference

A reference to the definition that this definition is a draft of, if this is a draft definition.

Optionaldrafts

drafts?: DefinitionReference[]

The list of drafts associated with this definition, if this is not a draft definition.

OptionaldropLocation

dropLocation?: string

The drop location for the definition.

Optionalid

id?: number

The ID of the referenced definition.

OptionaljobAuthorizationScope

jobAuthorizationScope?: BuildAuthorizationScope

The job authorization scope for builds queued against this definition.

OptionaljobCancelTimeoutInMinutes

jobCancelTimeoutInMinutes?: number

The job cancel timeout (in minutes) for builds cancelled by user for this definition.

OptionaljobTimeoutInMinutes

jobTimeoutInMinutes?: number

The job execution timeout (in minutes) for builds queued against this definition.

OptionallatestBuild

latestBuild?: Build

OptionallatestCompletedBuild

latestCompletedBuild?: Build

Optionalmetrics

metrics?: BuildMetric[]

Optionalname

name?: string

The name of the referenced definition.

Optionaloptions

options?: BuildOption[]

Optionalpath

path?: string

The folder path of the definition.

Optionalprocess

process?: BuildProcess

The build process.

OptionalprocessParameters

processParameters?: ProcessParameters

The process parameters for this definition.

Optionalproject

project?: TeamProjectReference

A reference to the project.

Optionalproperties

properties?: any

Optionalquality

quality?: DefinitionQuality

The quality of the definition document (draft, etc.)

Optionalqueue

queue?: AgentPoolQueue

The default queue for builds run against this definition.

OptionalqueueStatus

queueStatus?: DefinitionQueueStatus

A value that indicates whether builds can be queued against this definition.

Optionalrepository

repository?: BuildRepository

The repository.

OptionalretentionRules

retentionRules?: RetentionPolicy[]

Optionalrevision

revision?: number

The definition revision number.

Optionaltags

tags?: string[]

Optionaltriggers

triggers?: BuildTrigger[]

Optionaltype

type?: DefinitionType

The type of the definition.

Optionaluri

uri?: string

The definition's URI.

Optionalurl

url?: string

The REST URL of the definition.

OptionalvariableGroups

variableGroups?: VariableGroup[]

Optionalvariables

variables?: { [key: string]: BuildDefinitionVariable }

Settings

Member Visibility

On This Page

Properties