ClientTwin Class
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.
Properties of a device or module stored on the service.
[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Devices.ClientTwinJsonConverter))]
public class ClientTwin
[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Devices.ClientTwinJsonConverter))>]
type ClientTwin = class
Public Class ClientTwin
- Inheritance
-
ClientTwin
- Attributes
-
Newtonsoft.Json.JsonConverterAttribute
Constructors
ClientTwin() |
Creates an instance of this class. |
ClientTwin(ClientTwinDocument) |
Creates an instance of this class. |
ClientTwin(String) |
Creates an instance of this class. |
Properties
AuthenticationType |
Corresponding device's authentication type. |
Capabilities |
Gets the twin capabilities. |
CloudToDeviceMessageCount |
Number of messages sent to the corresponding device from the cloud. |
Configurations |
Gets the twin configuration properties. |
ConnectionState |
Corresponding device's connection state. |
DeviceId |
Gets and sets the twin Id. |
DeviceScope |
The scope of the device. Auto-generated and immutable for edge devices and modifiable in leaf devices to create child/parent relationship. |
ETag |
Twin's ETag. |
LastActiveOnUtc |
Time when the corresponding device was last active. |
ModelId |
The DTDL model Id of the device or module. |
ModuleId |
Gets and sets the twin module Id. |
ParentScopes |
The scopes of the upper level edge devices if applicable. Only available for edge devices. |
Properties |
Gets and sets the twin properties. |
Status |
Gets the corresponding device's status. |
StatusReason |
Reason, if any, for the corresponding device to be in specified status. |
StatusUpdatedOnUtc |
Time when the corresponding device's status was last updated. |
Tags |
Gets and sets the twin tags. |
Version |
Twin's version. |
X509Thumbprint |
Corresponding device's X509 thumbprint. |