DataFactoryResource.CancelPipelineRun 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 Azure.Response CancelPipelineRun (string runId, bool? isRecursive = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CancelPipelineRun : string * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response
override this.CancelPipelineRun : string * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function CancelPipelineRun (runId As String, Optional isRecursive As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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
Collabora con noi su GitHub
L'origine di questo contenuto è disponibile in GitHub, in cui è anche possibile creare ed esaminare i problemi e le richieste pull. Per ulteriori informazioni, vedere la guida per i collaboratori.