ScheduledJobsClient.CancelAsync(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<Microsoft.Azure.Devices.ScheduledJob> CancelAsync (string jobId, System.Threading.CancellationToken cancellationToken = default);
abstract member CancelAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ScheduledJob>
override this.CancelAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ScheduledJob>
Public Overridable Function CancelAsync (jobId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ScheduledJob)
Parameters
- jobId
- String
Id of the job to cancel.
- cancellationToken
- CancellationToken
Task cancellation token.
Returns
A job object
Exceptions
When the provided jobId
is null.
If the jobId
is empty or white space.
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 cancellationToken
has requested cancellation.