Share via


IPipelinesOperations.CreateRunWithHttpMessagesAsync Method

Definition

Creates a run of a pipeline.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.DataFactory.Models.CreateRunResponse>> CreateRunWithHttpMessagesAsync (string resourceGroupName, string factoryName, string pipelineName, string referencePipelineRunId = default, bool? isRecovery = default, string startActivityName = default, bool? startFromFailure = default, System.Collections.Generic.IDictionary<string,object> parameters = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateRunWithHttpMessagesAsync : string * string * string * string * Nullable<bool> * string * Nullable<bool> * System.Collections.Generic.IDictionary<string, obj> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.DataFactory.Models.CreateRunResponse>>
Public Function CreateRunWithHttpMessagesAsync (resourceGroupName As String, factoryName As String, pipelineName As String, 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 parameters As IDictionary(Of String, Object) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of CreateRunResponse))

Parameters

resourceGroupName
String

The resource group name.

factoryName
String

The factory name.

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.

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

parameters
IDictionary<String,Object>

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

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to