IotHubBaseClient.GetTwinPropertiesAsync(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.
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
The twin object for the current client.
Exceptions
Thrown if the client instance is not opened already.
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.
Applies to
Azure SDK for .NET
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for