DataFactoryPipelineResource.CreateRunAsync 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.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun
- Operation Id: Pipelines_CreateRun
- Default Api Version: 2018-06-01
- Resource: DataFactoryPipelineResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DataFactory.Models.PipelineCreateRunResult>> CreateRunAsync (System.Collections.Generic.IDictionary<string,BinaryData> parameterValueSpecification = default, string referencePipelineRunId = default, bool? isRecovery = default, string startActivityName = default, bool? startFromFailure = default, System.Threading.CancellationToken cancellationToken = default);abstract member CreateRunAsync : System.Collections.Generic.IDictionary<string, BinaryData> * string * Nullable<bool> * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DataFactory.Models.PipelineCreateRunResult>>
override this.CreateRunAsync : System.Collections.Generic.IDictionary<string, BinaryData> * string * Nullable<bool> * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DataFactory.Models.PipelineCreateRunResult>>Public Overridable Function CreateRunAsync (Optional parameterValueSpecification As IDictionary(Of String, BinaryData) = Nothing, Optional referencePipelineRunId As String = Nothing, Optional isRecovery As Nullable(Of Boolean) = Nothing, Optional startActivityName As String = Nothing, Optional startFromFailure As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PipelineCreateRunResult))Parameters
- parameterValueSpecification
- IDictionary<String,BinaryData>
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.
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.
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.
- cancellationToken
- CancellationToken
The cancellation token to use.
