PipelineClient.CreatePipelineRun Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Creates a run of a pipeline.
public virtual Azure.Response<Azure.Analytics.Synapse.Artifacts.Models.CreateRunResponse> CreatePipelineRun(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 CreatePipelineRun : string * string * Nullable<bool> * string * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Synapse.Artifacts.Models.CreateRunResponse>
override this.CreatePipelineRun : string * string * Nullable<bool> * string * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Synapse.Artifacts.Models.CreateRunResponse>Public Overridable Function CreatePipelineRun (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 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.
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.
