DevicesClient.GetAsync(String, CancellationToken) Method

Definition

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Package:

Microsoft.Azure.Devices v2.0.0-preview002

Get a device identity by its Id.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.Device> GetAsync (string deviceId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Device>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Device>

Public Overridable Function GetAsync (deviceId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Device)

Parameters

deviceId

String

The unique identifier of the device identity to retrieve.

cancellationToken

CancellationToken

The token which allows the operation to be canceled.

Returns

Task<Device>

The retrieved device identity.

Exceptions

ArgumentNullException

When the provided device Id is null.

ArgumentException

When the provided device 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.