Share via


ScheduledJobsClient.GetAsync(String, CancellationToken) Method

Definition

Gets the job with the specified Id.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.ScheduledJob> GetAsync (string jobId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ScheduledJob>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ScheduledJob>
Public Overridable Function GetAsync (jobId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ScheduledJob)

Parameters

jobId
String

Id of the job to get.

cancellationToken
CancellationToken

Task cancellation token.

Returns

The matching sheduled 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.

Applies to