Share via

Module interface

  • Reference
Package:
azure-iothub

Properties

authentication

Contains the symmetric keys used to authenticate this module.
cloudToDeviceMessageCount

Number of c2d messages waiting to by delivered to the module.
connectionState

Whether the module is 'connected' or 'disconnected'. It is not recommended to use this property to determine if the module is actually connected right now though, since the module connection may have timed out and the IoT hub may not have detected it.
connectionStateUpdatedTime

Timestamp representing the last time connectionState changed.
deviceId

Unique device identifier as it exists in the Azure IoT hub device registry.
etag

Weak entity tag assigned to this module identity description
generationId

Used to disambiguate devices that have been deleted/recreated with the same moduleId
lastActivityTime

Timestamp representing the last time the module authenticated, sent a message, or received a message.
managedBy

Represents the modules managed by owner
moduleId

Module ID

Property Details

authentication

Contains the symmetric keys used to authenticate this module.

authentication?: Authentication

Property Value

Authentication

cloudToDeviceMessageCount

Number of c2d messages waiting to by delivered to the module.

cloudToDeviceMessageCount?: string

Property Value

string

connectionState

Whether the module is 'connected' or 'disconnected'. It is not recommended to use this property to determine if the module is actually connected right now though, since the module connection may have timed out and the IoT hub may not have detected it.

connectionState?: ConnectionState

Property Value

ConnectionState

connectionStateUpdatedTime

Timestamp representing the last time connectionState changed.

connectionStateUpdatedTime?: string

Property Value

string

deviceId

Unique device identifier as it exists in the Azure IoT hub device registry.

deviceId: string

Property Value

string

etag

Weak entity tag assigned to this module identity description

etag?: string

Property Value

string

generationId

Used to disambiguate devices that have been deleted/recreated with the same moduleId

generationId?: string

Property Value

string

lastActivityTime

Timestamp representing the last time the module authenticated, sent a message, or received a message.

lastActivityTime?: string

Property Value

string

managedBy

Represents the modules managed by owner

managedBy?: string

Property Value

string

moduleId

Module ID

moduleId: string

Property Value

string