DeviceTwinInfo interface

  • Reference
Package:
@azure/eventgrid

Information about the device twin, which is the cloud representation of application device metadata.

Properties

authenticationType

Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority.
cloudToDeviceMessageCount

Count of cloud to device messages sent to this device.
connectionState

Whether the device is connected or disconnected.
deviceId

The unique identifier of the device twin.
etag

A piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin.
lastActivityTime

The ISO8601 timestamp of the last activity.
properties

Properties JSON element.
status

Whether the device twin is enabled or disabled.
statusUpdateTime

The ISO8601 timestamp of the last device twin status update.
version

An integer that is incremented by one each time the device twin is updated.
x509Thumbprint

The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.

Property Details

authenticationType

Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority.

authenticationType?: string

Property Value

string

cloudToDeviceMessageCount

Count of cloud to device messages sent to this device.

cloudToDeviceMessageCount?: number

Property Value

number

connectionState

Whether the device is connected or disconnected.

connectionState?: string

Property Value

string

deviceId

The unique identifier of the device twin.

deviceId?: string

Property Value

string

etag

A piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin.

etag?: string

Property Value

string

lastActivityTime

The ISO8601 timestamp of the last activity.

lastActivityTime?: string

Property Value

string

properties

Properties JSON element.

properties?: DeviceTwinInfoProperties

Property Value

DeviceTwinInfoProperties

status

Whether the device twin is enabled or disabled.

status?: string

Property Value

string

statusUpdateTime

The ISO8601 timestamp of the last device twin status update.

statusUpdateTime?: string

Property Value

string

version

An integer that is incremented by one each time the device twin is updated.

version?: number

Property Value

number

x509Thumbprint

The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.

x509Thumbprint?: DeviceTwinInfoX509Thumbprint

Property Value

DeviceTwinInfoX509Thumbprint