DevicesClient.CancelJobAsync(String, CancellationToken) Method

Definition

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Package:

Microsoft.Azure.Devices v2.0.0-preview002

Cancels/deletes the job with the specified Id.

public virtual System.Threading.Tasks.Task CancelJobAsync (string jobId, System.Threading.CancellationToken cancellationToken = default);

abstract member CancelJobAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CancelJobAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function CancelJobAsync (jobId As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

jobId

String

Id of the job to cancel.

cancellationToken

CancellationToken

The token which allows the operation to be canceled.

Returns

Task

Exceptions

ArgumentNullException

When the provided job Id is null.

ArgumentException

When the provided job Id is empty or whitespace.

IotHubServiceException

If IoT hub responded to the request with a non-successful status code. For example, if the provided request was throttled, IotHubServiceException with ThrottlingException is thrown. For a complete list of possible error cases, see IotHubServiceErrorCode.

HttpRequestException

If the HTTP request fails due to an underlying issue such as network connectivity, DNS failure, or server certificate validation.

OperationCanceledException

If the provided cancellation token has requested cancellation.