BuildDefinition interface

Represents a build definition.

Extends

Properties

badgeEnabled

Indicates whether badges are enabled for this definition.

buildNumberFormat

The build number format.

comment

A save-time comment for the definition.

demands
description

The description.

dropLocation

The drop location for the definition.

jobAuthorizationScope

The job authorization scope for builds queued against this definition.

jobCancelTimeoutInMinutes

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

jobTimeoutInMinutes

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

options
process

The build process.

processParameters

The process parameters for this definition.

properties
repository

The repository.

retentionRules
tags
triggers
variableGroups
variables

Inherited Properties

authoredBy

The author of the definition.

createdDate

The date this version of the definition was created.

draftOf

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

drafts

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

id

The ID of the referenced definition.

latestBuild
latestCompletedBuild
metrics
name

The name of the referenced definition.

path

The folder path of the definition.

project

A reference to the project.

quality

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

queue

The default queue for builds run against this definition.

queueStatus

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

revision

The definition revision number.

type

The type of the definition.

uri

The definition's URI.

url

The REST URL of the definition.

Property Details

badgeEnabled

Indicates whether badges are enabled for this definition.

badgeEnabled: boolean

Property Value

boolean

buildNumberFormat

The build number format.

buildNumberFormat: string

Property Value

string

comment

A save-time comment for the definition.

comment: string

Property Value

string

demands

demands: Demand[]

Property Value

Demand[]

description

The description.

description: string

Property Value

string

dropLocation

The drop location for the definition.

dropLocation: string

Property Value

string

jobAuthorizationScope

The job authorization scope for builds queued against this definition.

jobAuthorizationScope: BuildAuthorizationScope

Property Value

jobCancelTimeoutInMinutes

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

jobCancelTimeoutInMinutes: number

Property Value

number

jobTimeoutInMinutes

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

jobTimeoutInMinutes: number

Property Value

number

options

options: BuildOption[]

Property Value

process

The build process.

process: BuildProcess

Property Value

processParameters

The process parameters for this definition.

processParameters: ProcessParameters

Property Value

properties

properties: any

Property Value

any

repository

The repository.

repository: BuildRepository

Property Value

retentionRules

retentionRules: RetentionPolicy[]

Property Value

tags

tags: string[]

Property Value

string[]

triggers

triggers: BuildTrigger[]

Property Value

variableGroups

variableGroups: VariableGroup[]

Property Value

variables

variables: {[key: string]: BuildDefinitionVariable}

Property Value

{[key: string]: BuildDefinitionVariable}

Inherited Property Details

authoredBy

The author of the definition.

authoredBy: IdentityRef

Property Value

Inherited From BuildDefinitionReference.authoredBy

createdDate

The date this version of the definition was created.

createdDate: Date

Property Value

Date

Inherited From BuildDefinitionReference.createdDate

draftOf

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

draftOf: DefinitionReference

Property Value

Inherited From BuildDefinitionReference.draftOf

drafts

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

drafts: DefinitionReference[]

Property Value

Inherited From BuildDefinitionReference.drafts

id

The ID of the referenced definition.

id: number

Property Value

number

Inherited From BuildDefinitionReference.id

latestBuild

latestBuild: Build

Property Value

Inherited From BuildDefinitionReference.latestBuild

latestCompletedBuild

latestCompletedBuild: Build

Property Value

Inherited From BuildDefinitionReference.latestCompletedBuild

metrics

metrics: BuildMetric[]

Property Value

Inherited From BuildDefinitionReference.metrics

name

The name of the referenced definition.

name: string

Property Value

string

Inherited From BuildDefinitionReference.name

path

The folder path of the definition.

path: string

Property Value

string

Inherited From BuildDefinitionReference.path

project

A reference to the project.

project: TeamProjectReference

Property Value

Inherited From BuildDefinitionReference.project

quality

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

quality: DefinitionQuality

Property Value

Inherited From BuildDefinitionReference.quality

queue

The default queue for builds run against this definition.

queue: AgentPoolQueue

Property Value

Inherited From BuildDefinitionReference.queue

queueStatus

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

queueStatus: DefinitionQueueStatus

Property Value

Inherited From BuildDefinitionReference.queueStatus

revision

The definition revision number.

revision: number

Property Value

number

Inherited From BuildDefinitionReference.revision

type

The type of the definition.

type: DefinitionType

Property Value

Inherited From BuildDefinitionReference.type

uri

The definition's URI.

uri: string

Property Value

string

Inherited From BuildDefinitionReference.uri

url

The REST URL of the definition.

url: string

Property Value

string

Inherited From BuildDefinitionReference.url