DevicesClient.CancelJobAsync(String, CancellationToken) 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.
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.TaskPublic Overridable Function CancelJobAsync (jobId As String, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- jobId
- String
Id of the job to cancel.
- cancellationToken
- CancellationToken
The token which allows the operation to be canceled.
Returns
Exceptions
When the provided job Id is null.
When the provided job Id is empty or whitespace.
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.
If the HTTP request fails due to an underlying issue such as network connectivity, DNS failure, or server certificate validation.
If the provided cancellation token has requested cancellation.
