Interface RunPipelineParameters

Settings which influence pipeline runs.

interface RunPipelineParameters {
    previewRun?: boolean;
    resources?: RunResourcesParameters;
    stagesToSkip?: string[];
    templateParameters?: { [key: string]: string };
    variables?: { [key: string]: Variable };
    yamlOverride?: string;
}

Properties

previewRun? resources? stagesToSkip? templateParameters? variables? yamlOverride?

Properties

OptionalpreviewRun

previewRun?: boolean

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

Optionalresources

resources?: RunResourcesParameters

The resources the run requires.

OptionalstagesToSkip

stagesToSkip?: string[]

OptionaltemplateParameters

templateParameters?: { [key: string]: string }

Optionalvariables

variables?: { [key: string]: Variable }

OptionalyamlOverride

yamlOverride?: string

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.

Settings

Member Visibility

On This Page

Properties