PipelineCreatePipelineRunOptionalParams interface

Package:

@azure/synapse-artifacts

Optional parameters.

Extends

OperationOptions

Properties

isRecovery	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	Parameters of the pipeline run. These parameters will be used only if the runId is not specified.
referencePipelineRunId	The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.
startActivityName	In recovery mode, the rerun will start from this activity. If not specified, all activities will run.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	Options used when tracing is enabled.

Property Details

isRecovery

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.

isRecovery?: boolean

Property Value

boolean

parameters

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

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

Property Value

{[propertyName: string]: any}

referencePipelineRunId

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

referencePipelineRunId?: string

Property Value

string

startActivityName

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

startActivityName?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From coreClient.OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From coreClient.OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From coreClient.OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From coreClient.OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From coreClient.OperationOptions.tracingOptions