BuildDefinition3_2 interface

Package:

azure-devops-extension-api

For back-compat with extensions that use the old Steps format instead of Process and Phases

Extends

BuildDefinitionReference3_2

Properties

badgeEnabled	Indicates whether badges are enabled for this definition
build
buildNumberFormat	The build number format
comment	The comment entered when saving the definition
demands
description	The description
dropLocation	The drop location for the definition
jobAuthorizationScope	The job authorization scope for builds which are queued against this definition
jobCancelTimeoutInMinutes	The job cancel timeout in minutes for builds which are cancelled by user for this definition
jobTimeoutInMinutes	The job execution timeout in minutes for builds which are queued against this definition
latestBuild
latestCompletedBuild
options
processParameters	Process Parameters
properties
repository	The repository
retentionRules
tags
triggers
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.
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

build

build: BuildDefinitionStep[]

Property Value

BuildDefinitionStep[]

buildNumberFormat

The build number format

buildNumberFormat: string

Property Value

string

comment

The comment entered when saving 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 which are queued against this definition

jobAuthorizationScope: BuildAuthorizationScope

Property Value

BuildAuthorizationScope

jobCancelTimeoutInMinutes

The job cancel timeout in minutes for builds which are cancelled by user for this definition

jobCancelTimeoutInMinutes: number

Property Value

number

jobTimeoutInMinutes

The job execution timeout in minutes for builds which are queued against this definition

jobTimeoutInMinutes: number

Property Value

number

latestBuild

latestBuild: Build

Property Value

Build

latestCompletedBuild

latestCompletedBuild: Build

Property Value

Build

options

options: BuildOption[]

Property Value

BuildOption[]

processParameters

Process Parameters

processParameters: ProcessParameters

Property Value

ProcessParameters

properties

properties: any

Property Value

any

repository

The repository

repository: BuildRepository

Property Value

BuildRepository

retentionRules

retentionRules: RetentionPolicy[]

Property Value

RetentionPolicy[]

tags

tags: string[]

Property Value

string[]

triggers

triggers: BuildTrigger[]

Property Value

BuildTrigger[]

variables

variables: {[key: string]: BuildDefinitionVariable}

Property Value

{[key: string]: BuildDefinitionVariable}

Inherited Property Details

authoredBy

The author of the definition.

authoredBy: IdentityRef

Property Value

IdentityRef

Inherited From BuildDefinitionReference3_2.authoredBy

createdDate

The date this version of the definition was created.

createdDate: Date

Property Value

Date

Inherited From BuildDefinitionReference3_2.createdDate

draftOf

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

draftOf: DefinitionReference

Property Value

DefinitionReference

Inherited From BuildDefinitionReference3_2.draftOf

drafts

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

drafts: DefinitionReference[]

Property Value

DefinitionReference[]

Inherited From BuildDefinitionReference3_2.drafts

id

The ID of the referenced definition.

id: number

Property Value

number

Inherited From BuildDefinitionReference3_2.id

metrics

metrics: BuildMetric[]

Property Value

BuildMetric[]

Inherited From BuildDefinitionReference3_2.metrics

name

The name of the referenced definition.

name: string

Property Value

string

Inherited From BuildDefinitionReference3_2.name

path

The folder path of the definition.

path: string

Property Value

string

Inherited From BuildDefinitionReference3_2.path

project

A reference to the project.

project: TeamProjectReference

Property Value

TeamProjectReference

Inherited From BuildDefinitionReference3_2.project

quality

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

quality: DefinitionQuality

Property Value

DefinitionQuality

Inherited From BuildDefinitionReference3_2.quality

queue

The default queue for builds run against this definition.

queue: AgentPoolQueue

Property Value

AgentPoolQueue

Inherited From BuildDefinitionReference3_2.queue

queueStatus

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

queueStatus: DefinitionQueueStatus

Property Value

DefinitionQueueStatus

Inherited From BuildDefinitionReference3_2.queueStatus

revision

The definition revision number.

revision: number

Property Value

number

Inherited From BuildDefinitionReference3_2.revision

type

The type of the definition.

type: DefinitionType

Property Value

DefinitionType

Inherited From BuildDefinitionReference3_2.type

uri

The definition's URI.

uri: string

Property Value

string

Inherited From BuildDefinitionReference3_2.uri

url

The REST URL of the definition.

url: string

Property Value

string

Inherited From BuildDefinitionReference3_2.url