Azure Pipelines

Azure Pipelines YAML pipelines definition

Type pipeline | string
File match azure-pipelines.yml azure-pipelines.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/azure-pipelines/latest.json
Source https://raw.githubusercontent.com/microsoft/azure-pipelines-vscode/master/service-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: pipeline | string

A pipeline definition

One of

1. pipeline object | object | object | object | object | object | object
2. string string

Definitions

string string
sequence any[]
mapping object
any string | any[] | object
pipeline object | object | object | object | object | object | object
pipelineBase object
name string
appendCommitMessageToRunName string | string | string | string | string | string | string | string
trigger string | branchFilter[] | object
parameters pipelineTemplateParameter[]
pr string | branchFilter[] | object
schedules schedule[]
resources object | legacyResource[]
variables object | variable[]
lockBehavior string | string
pipelineTrigger object
trigger string | branchFilter[] | object
name string | any[] | object
appendCommitMessageToRunName string | any[] | object
parameters string | any[] | object
pr string | any[] | object
schedules string | any[] | object
resources string | any[] | object
variables string | any[] | object
stages string | any[] | object
jobs string | any[] | object
extends string | any[] | object
phases string | any[] | object
strategy string | any[] | object
continueOnError string | any[] | object
pool string | any[] | object
container string | any[] | object
services string | any[] | object
workspace string | any[] | object
steps string | any[] | object
queue string | any[] | object
server string | any[] | object
lockBehavior string | string
pipelineParameters object
parameters pipelineTemplateParameter[]
name string | any[] | object
appendCommitMessageToRunName string | any[] | object
trigger string | any[] | object
pr string | any[] | object
schedules string | any[] | object
resources string | any[] | object
variables string | any[] | object
stages string | any[] | object
jobs string | any[] | object
extends string | any[] | object
phases string | any[] | object
strategy string | any[] | object
continueOnError string | any[] | object
pool string | any[] | object
container string | any[] | object
services string | any[] | object
workspace string | any[] | object
steps string | any[] | object
queue string | any[] | object
server string | any[] | object
lockBehavior string | string
pipelinePR object
pr string | branchFilter[] | object
name string | any[] | object
appendCommitMessageToRunName string | any[] | object
trigger string | any[] | object
parameters string | any[] | object
schedules string | any[] | object
resources string | any[] | object
variables string | any[] | object
stages string | any[] | object
jobs string | any[] | object
extends string | any[] | object
phases string | any[] | object
strategy string | any[] | object
continueOnError string | any[] | object
pool string | any[] | object
container string | any[] | object
services string | any[] | object
workspace string | any[] | object
steps string | any[] | object
queue string | any[] | object
server string | any[] | object
lockBehavior string | string
pipelineSchedules object
schedules schedule[]
name string | any[] | object
appendCommitMessageToRunName string | any[] | object
trigger string | any[] | object
parameters string | any[] | object
pr string | any[] | object
resources string | any[] | object
variables string | any[] | object
stages string | any[] | object
jobs string | any[] | object
extends string | any[] | object
phases string | any[] | object
strategy string | any[] | object
continueOnError string | any[] | object
pool string | any[] | object
container string | any[] | object
services string | any[] | object
workspace string | any[] | object
steps string | any[] | object
queue string | any[] | object
server string | any[] | object
lockBehavior string | string
pipelineAnyBase object
name string | any[] | object
appendCommitMessageToRunName string | any[] | object
trigger string | any[] | object
parameters string | any[] | object
pr string | any[] | object
schedules string | any[] | object
resources string | any[] | object
variables string | any[] | object
stages string | any[] | object
jobs string | any[] | object
extends string | any[] | object
phases string | any[] | object
strategy string | any[] | object
continueOnError string | any[] | object
pool string | any[] | object
container string | any[] | object
services string | any[] | object
workspace string | any[] | object
steps string | any[] | object
queue string | any[] | object
server string | any[] | object
lockBehavior string | string
pr string | branchFilter[] | object
trigger string | branchFilter[] | object
includeExcludeFilters object
include branchFilter[]
exclude branchFilter[]
includeExcludeStringFilters nonEmptyString[] | object
branchFilterArray branchFilter[]
branchFilter string

branch name or prefix filter

templateParameters templateParameter[] | object
templateParameter object
name string
displayName string
type string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string
default string | any[] | object
values nonEmptyString[]
templateParameterType string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string
pipelineTemplateParameters pipelineTemplateParameter[]
pipelineTemplateParameter object
name string
displayName string
type string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string
default string | any[] | object
values nonEmptyString[]
pipelineTemplateParameterType string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string | string
schedules schedule[]
schedule object
cron string
displayName string
branches object
2 nested properties
include branchFilter[]
exclude branchFilter[]
batch string | string | string | string | string | string | string | string
always string | string | string | string | string | string | string | string
resources object | legacyResource[]
buildResources buildResource[]
buildResource object
build string required
pattern=^[-_A-Za-z0-9]*$
type string required
connection string required
source string required
version string
branch string
trigger string | string
buildResourceTrigger string | string
packageResources packageResource[]
packageResource object
package string required
pattern=^[-_A-Za-z0-9]*$
type string required
connection string required
name string required
version string
tag string
trigger string | string
packageResourceTrigger string | string
containerResources containerResource[]
containerResource object
container string required
pattern=^[-_A-Za-z0-9]*$
image string required
type string | string
trigger string | string | object
azureSubscription string
resourceGroup string
registry string
repository string
localImage string | string | string | string | string | string | string | string
endpoint string
env object
mapDockerSocket string | string | string | string | string | string | string | string
options string
ports string_allowExpressions[]
volumes string_allowExpressions[]
mountReadOnly object
4 nested properties
work string | string | string | string | string | string | string | string
externals string | string | string | string | string | string | string | string
tools string | string | string | string | string | string | string | string
tasks string | string | string | string | string | string | string | string
containerArtifactType string | string
containerResourceTrigger string | string | object
pipelineResources pipelineResource[]
pipelineResource object
pipeline string required
pattern=^[-_A-Za-z0-9]*$
project string
source string
version string
branch string
tags nonEmptyString[]
trigger string | string | object
pipelineResourceTrigger string | string | object
triggerBranchFilter object | branchFilter[]
repositoryResources repositoryResource[]
repositoryResource object
repository string required
pattern=^[-_A-Za-z0-9]*$
endpoint string
trigger string | branchFilter[] | object
checkoutOptions object
6 nested properties
clean string
fetchDepth string
fetchTags string
lfs string
submodules string
persistCredentials string
name string
ref string
type string
repositoryCheckoutOptions object
clean string
fetchDepth string
fetchTags string
lfs string
submodules string
persistCredentials string
legacyResource object
repo string
pattern=^self$
clean string
fetchDepth string
lfs string
legacyRepoResourceAlias string
webhookResources webhookResource[]
webhookResource object
webhook string required
pattern=^[-_A-Za-z0-9]*$
connection string required
type string
filters webhookFilter[]
webhookFilters webhookFilter[]
webhookFilter object
path string required
value string required
variablesTemplate object
parameters templateParameter[] | object
variables object | variable[]
variables object | variable[]
variable object | object | object
stagesTemplate object
parameters templateParameter[] | object
stages stage[]
stages stage[]
stage object | object
checks check[]
check object
type string

Production readiness check

pattern=^productionReadinessPolicy$
checkType string

Production readiness check

lockBehavior string | string
stageTrigger string | string
extendsParameters templateParameter[]
extendsTemplate object | object | object | object
extendsTemplateBase object
trigger string | branchFilter[] | object
resources object | legacyResource[]
parameters templateParameter[]
variables object | variable[]
parametersTemplate object | object | object | object
extends object
template string
parameters object
jobsTemplate object | object
jobs job[]
job object | object | object
explicitResources object
repositories nonEmptyString[]
pools nonEmptyString[]
pool string | object

Pool details

poolDemands string | nonEmptyString[]
jobContainer string | object | object
containerBase object
image string required
endpoint string
env object
mapDockerSocket string | string | string | string | string | string | string | string
options string
ports string_allowExpressions[]
volumes string_allowExpressions[]
mountReadOnly object
4 nested properties
work string | string | string | string | string | string | string | string
externals string | string | string | string | string | string | string | string
tools string | string | string | string | string | string | string | string
tasks string | string | string | string | string | string | string | string
readOnlyMounts object
work string | string | string | string | string | string | string | string
externals string | string | string | string | string | string | string | string
tools string | string | string | string | string | string | string | string
tasks string | string | string | string | string | string | string | string
jobServices object
jobWorkspace object
clean string
jobStrategy object | object
jobMatrix object | string
matrixProperties object

Variable-value pair to pass in this matrix instance

deploymentEnvironment string | object

Environment details

deploymentStrategy object | object | object
preDeployHook object
steps step[]
pool string | object

Pool details

deployHook object
steps step[]
pool string | object

Pool details

routeTrafficHook object
steps step[]
pool string | object

Pool details

postRouteTrafficHook object
steps step[]
pool string | object

Pool details

onSuccessOrFailureHook object
failure object
2 nested properties
steps step[]
pool string | object

Pool details

success object
2 nested properties
steps step[]
pool string | object

Pool details

onFailureHook object
steps step[]
pool string | object

Pool details

onSuccessHook object
steps step[]
pool string | object

Pool details

runOnceDeploymentStrategy object
preDeploy object
2 nested properties
steps step[]
pool string | object

Pool details

deploy object
2 nested properties
steps step[]
pool string | object

Pool details

routeTraffic object
2 nested properties
steps step[]
pool string | object

Pool details

postRouteTraffic object
2 nested properties
steps step[]
pool string | object

Pool details

on object
2 nested properties
failure object
2 nested properties
steps step[]
pool string | object

Pool details

success object
2 nested properties
steps step[]
pool string | object

Pool details

rollingDeploymentStrategy object
maxParallel string
preDeploy object
2 nested properties
steps step[]
pool string | object

Pool details

deploy object
2 nested properties
steps step[]
pool string | object

Pool details

routeTraffic object
2 nested properties
steps step[]
pool string | object

Pool details

postRouteTraffic object
2 nested properties
steps step[]
pool string | object

Pool details

on object
2 nested properties
failure object
2 nested properties
steps step[]
pool string | object

Pool details

success object
2 nested properties
steps step[]
pool string | object

Pool details

canaryDeploymentStrategy object
increments nonEmptyString[]
preDeploy object
2 nested properties
steps step[]
pool string | object

Pool details

deploy object
2 nested properties
steps step[]
pool string | object

Pool details

routeTraffic object
2 nested properties
steps step[]
pool string | object

Pool details

postRouteTraffic object
2 nested properties
steps step[]
pool string | object

Pool details

on object
2 nested properties
failure object
2 nested properties
steps step[]
pool string | object

Pool details

success object
2 nested properties
steps step[]
pool string | object

Pool details

canaryDeploymentIncrements nonEmptyString[]
phases phase[]
phase object | object | object
phaseQueueTarget string | object

Queue details

phaseServerTarget string | object
phaseTargetDemands string | nonEmptyString[]
phaseTargetWorkspace object
clean string
phaseTargetMatrix object | string

List of permutations of variable values to run

stepsTemplate object
parameters templateParameter[] | object
steps step[]
steps step[]
step object | object | object | object | object | object | object | object | object | object | object | object | object
stepTarget string | object

Step target

variableRestrictions string | nonEmptyString[]
jobDecoratorSteps object
steps task[]
tasks task[]
taskBase object
condition string
continueOnError string | string | string | string | string | string | string | string
displayName string
target string | object

Step target

enabled string | string | string | string | string | string | string | string
env object
name string
pattern=^[-_A-Za-z0-9]*$
timeoutInMinutes string
retryCountOnTaskFailure string
jobContinueOnError string
jobDependsOn string | string[]
referenceName string
templateContext object
boolean string | string | string | string | string | string | string | string
string_allowExpressions string
nonEmptyString string
sequenceOfNonEmptyString nonEmptyString[]
sequenceOfString_allowExpressions string_allowExpressions[]
mappingOfStringString object
any_allowExpressions string | any[] | object
task object
task enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum | enum
displayName string

Human-readable name for the task

name string

ID of the task instance

pattern=^[_A-Za-z0-9]*$
condition string

Evaluate this condition expression to determine whether to run this task

continueOnError boolean

Continue running the parent job even on failure?

enabled string

Run this task when the job runs?

retryCountOnTaskFailure integer

Number of retries if the task fails

timeoutInMinutes integer

Time to wait for this task to complete before the server kills it

inputs object

Task-specific inputs

env object

Variables to map into the process's environment