Partilhar via


DataFactoryResource.CancelPipelineRunAsync Método

Definição

Cancele um pipeline executado por sua ID de execução.

  • Caminho da Solicitação/assinaturas/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/cancel
  • Operação IdPipelineRuns_Cancel
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)

Parâmetros

runId
String

O identificador de execução do pipeline.

isRecursive
Nullable<Boolean>

Se for true, cancele todos os pipelines filho que são disparados pelo pipeline atual.

cancellationToken
CancellationToken

O token de cancelamento a ser usado.

Retornos

Exceções

runId é uma cadeia de caracteres vazia e esperava-se que não estivesse vazia.

runId é nulo.

Aplica-se a