RunPipelineParameters interface

  • Reference
Package:
azure-devops-extension-api

Settings which influence pipeline runs.

Properties

previewRun

If true, don't actually create a new run. Instead, return the final YAML document after parsing templates.
resources

The resources the run requires.
stagesToSkip
templateParameters
variables
yamlOverride

If you use the preview run option, you may optionally supply different YAML. This allows you to preview the final YAML document without committing a changed file.

Property Details

previewRun

If true, don't actually create a new run. Instead, return the final YAML document after parsing templates.

previewRun: boolean

Property Value

boolean

resources

The resources the run requires.

resources: RunResourcesParameters

Property Value

RunResourcesParameters

stagesToSkip 

stagesToSkip: string[]

Property Value

string[]

templateParameters 

templateParameters: {[key: string]: string}

Property Value

{[key: string]: string}

variables 

variables: {[key: string]: Variable}

Property Value

{[key: string]: Variable}

yamlOverride

If you use the preview run option, you may optionally supply different YAML. This allows you to preview the final YAML document without committing a changed file.

yamlOverride: string

Property Value

string