DataFactoryResource.CancelPipelineRunAsync 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.
Cancel a pipeline run by its run ID.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/cancel
- Operation Id: PipelineRuns_Cancel
- Default Api Version: 2018-06-01
public virtual System.Threading.Tasks.Task<Azure.Response> CancelPipelineRunAsync (string runId, bool? isRecursive = default, System.Threading.CancellationToken cancellationToken = default);abstract member CancelPipelineRunAsync : string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.CancelPipelineRunAsync : string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function CancelPipelineRunAsync (runId As String, Optional isRecursive As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Parameters
- runId
- String
The pipeline run identifier.
If true, cancel all the Child pipelines that are triggered by the current pipeline.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
runId is an empty string, and was expected to be non-empty.
runId is null.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure SDK for .NET