BuildDefinition interface
Represents a build definition.
- Extends
Properties
| badge |
Indicates whether badges are enabled for this definition. |
| build |
The build number format. |
| comment | A save-time comment for the definition. |
| demands | |
| description | The description. |
| drop |
The drop location for the definition. |
| job |
The job authorization scope for builds queued against this definition. |
| job |
The job cancel timeout (in minutes) for builds cancelled by user for this definition. |
| job |
The job execution timeout (in minutes) for builds queued against this definition. |
| options | |
| process | The build process. |
| process |
The process parameters for this definition. |
| properties | |
| repository | The repository. |
| retention |
|
| tags | |
| triggers | |
| variable |
|
| variables |
Inherited Properties
| authored |
The author of the definition. |
| created |
The date this version of the definition was created. |
| draft |
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. |
| latest |
|
| latest |
|
| 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. |
| queue |
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: booleanProperty Value
boolean
buildNumberFormat
The build number format.
buildNumberFormat: stringProperty Value
string
comment
A save-time comment for the definition.
comment: stringProperty Value
string
demands
description
The description.
description: stringProperty Value
string
dropLocation
The drop location for the definition.
dropLocation: stringProperty Value
string
jobAuthorizationScope
The job authorization scope for builds queued against this definition.
jobAuthorizationScope: BuildAuthorizationScopeProperty Value
jobCancelTimeoutInMinutes
The job cancel timeout (in minutes) for builds cancelled by user for this definition.
jobCancelTimeoutInMinutes: numberProperty Value
number
jobTimeoutInMinutes
The job execution timeout (in minutes) for builds queued against this definition.
jobTimeoutInMinutes: numberProperty Value
number
options
process
processParameters
The process parameters for this definition.
processParameters: ProcessParametersProperty Value
properties
properties: anyProperty Value
any
repository
retentionRules
tags
tags: string[]Property Value
string[]
triggers
variableGroups
variables
variables: {[key: string]: BuildDefinitionVariable}Property Value
{[key: string]: BuildDefinitionVariable}
Inherited Property Details
authoredBy
The author of the definition.
authoredBy: IdentityRefProperty Value
Inherited From BuildDefinitionReference.authoredBy
createdDate
The date this version of the definition was created.
createdDate: DateProperty 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: DefinitionReferenceProperty 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: numberProperty Value
number
Inherited From BuildDefinitionReference.id
latestBuild
latestCompletedBuild
latestCompletedBuild: BuildProperty Value
Inherited From BuildDefinitionReference.latestCompletedBuild
metrics
name
The name of the referenced definition.
name: stringProperty Value
string
Inherited From BuildDefinitionReference.name
path
The folder path of the definition.
path: stringProperty Value
string
Inherited From BuildDefinitionReference.path
project
A reference to the project.
project: TeamProjectReferenceProperty Value
Inherited From BuildDefinitionReference.project
quality
The quality of the definition document (draft, etc.)
quality: DefinitionQualityProperty Value
Inherited From BuildDefinitionReference.quality
queue
The default queue for builds run against this definition.
queue: AgentPoolQueueProperty Value
Inherited From BuildDefinitionReference.queue
queueStatus
A value that indicates whether builds can be queued against this definition.
queueStatus: DefinitionQueueStatusProperty Value
Inherited From BuildDefinitionReference.queueStatus
revision
The definition revision number.
revision: numberProperty Value
number
Inherited From BuildDefinitionReference.revision
type
The type of the definition.
type: DefinitionTypeProperty Value
Inherited From BuildDefinitionReference.type
uri
url
The REST URL of the definition.
url: stringProperty Value
string
Inherited From BuildDefinitionReference.url