Package version:

Interface PipelinesCreateRunOptionalParams

Optional parameters.

interface PipelinesCreateRunOptionalParams {
    isRecovery?: boolean;
    parameters?: {
        [propertyName: string]: any;
    };
    referencePipelineRunId?: string;
    startActivityName?: string;
    startFromFailure?: boolean;
}

Hierarchy

  • unknown
    • PipelinesCreateRunOptionalParams

Properties

isRecovery?: boolean

Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.

parameters?: {
    [propertyName: string]: any;
}

Parameters of the pipeline run. These parameters will be used only if the runId is not specified.

referencePipelineRunId?: string

The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.

startActivityName?: string

In recovery mode, the rerun will start from this activity. If not specified, all activities will run.

startFromFailure?: boolean

In recovery mode, if set to true, the rerun will start from failed activities. The property will be used only if startActivityName is not specified.