Module Class

The module identity on a device.

Inheritance

Model

Module

Constructor

Module(*, module_id: Optional[str] = None, managed_by: Optional[str] = None, device_id: Optional[str] = None, generation_id: Optional[str] = None, etag: Optional[str] = None, connection_state=None, connection_state_updated_time=None, last_activity_time=None, cloud_to_device_message_count: Optional[int] = None, authentication=None, **kwargs)

Parameters

module_id

str

Required

The unique identifier of the module.

managed_by

str

Required

Identifies who manages this module. For instance, this value is "IotEdge" if the edge runtime owns this module.

device_id

str

Required

The unique identifier of the device.

generation_id

str

Required

The IoT Hub generated, case-sensitive string up to 128 characters long. This value is used to distinguish modules with the same moduleId, when they have been deleted and re-created.

etag

str

Required

The string representing a weak ETag for the module identity, as per RFC7232.

connection_state

str or <xref:protocol.models.enum>

Required

The connection state of the device. Possible values include: 'Disconnected', 'Connected'

connection_state_updated_time

datetime

Required

The date and time the connection state was last updated.

last_activity_time

datetime

Required

The date and time the device last connected, received, or sent a message.

cloud_to_device_message_count

int

Required

The number of cloud-to-module messages currently queued to be sent to the module.

authentication

AuthenticationMechanism

Required

The authentication mechanism used by the module when connecting to the service and edge hub.