DevicesClient.GetJobAsync(String, CancellationToken) Method

Definition

Gets the registry job with the specified Id.

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

Parameters

jobId
String

Id of the registry job to retrieve.

cancellationToken
CancellationToken

The token which allows the operation to be canceled.

Returns

JobProperties of the job specified by the provided jobId.

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.

Applies to