IotHubBaseClient.GetTwinPropertiesAsync(CancellationToken) Method

Definition

Namespace:

Microsoft.Azure.Devices.Client

Assembly:

Microsoft.Azure.Devices.Client.dll

Package:

Microsoft.Azure.Devices.Client v2.0.0-preview002

Retrieve the twin properties for the current client.

public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Client.TwinProperties> GetTwinPropertiesAsync (System.Threading.CancellationToken cancellationToken = default);

member this.GetTwinPropertiesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Client.TwinProperties>

Public Function GetTwinPropertiesAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of TwinProperties)

Parameters

cancellationToken

CancellationToken

A cancellation token to cancel the operation.

Returns

Task<TwinProperties>

The twin object for the current client.

Exceptions

InvalidOperationException

Thrown if the client instance is not opened already.

OperationCanceledException

Thrown when the operation has been canceled.

Remarks

The client instance must be opened already.

This API gives you the client's view of the twin. For more information on twins in IoT hub, see https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.