PipelineClient.CreatePipelineRunAsync Method

Definition

Namespace:

Azure.Analytics.Synapse.Artifacts

Assembly:

Azure.Analytics.Synapse.Artifacts.dll

Package:

Azure.Analytics.Synapse.Artifacts v1.0.0-preview.19

Source:

PipelineClient.cs

Creates a run of a pipeline.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Synapse.Artifacts.Models.CreateRunResponse>> CreatePipelineRunAsync (string pipelineName, string referencePipelineRunId = default, bool? isRecovery = default, string startActivityName = default, System.Collections.Generic.IDictionary<string,object> parameters = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreatePipelineRunAsync : string * string * Nullable<bool> * string * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Synapse.Artifacts.Models.CreateRunResponse>>
override this.CreatePipelineRunAsync : string * string * Nullable<bool> * string * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Synapse.Artifacts.Models.CreateRunResponse>>

Public Overridable Function CreatePipelineRunAsync (pipelineName As String, Optional referencePipelineRunId As String = Nothing, Optional isRecovery As Nullable(Of Boolean) = Nothing, Optional startActivityName As String = Nothing, Optional parameters As IDictionary(Of String, Object) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CreateRunResponse))

Parameters

pipelineName

String

The pipeline name.

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.

isRecovery

Nullable<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.

startActivityName

String

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

parameters

IDictionary<String,Object>

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

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<CreateRunResponse>>