ExportImportDevice Class

Reference

ExportImportDevice.

Inheritance: Model

ExportImportDevice

Constructor

ExportImportDevice(*, id: Optional[str] = None, module_id: Optional[str] = None, e_tag: Optional[str] = None, import_mode=None, status=None, status_reason: Optional[str] = None, authentication=None, twin_etag: Optional[str] = None, tags=None, properties=None, capabilities=None, device_scope: Optional[str] = None, parent_scopes=None, **kwargs)

Parameters

id: str

Required

The unique identifier of the device.

module_id: str

Required

The unique identifier of the module, if applicable.

e_tag: str

Required

The string representing a weak ETag for the device RFC7232. The value is only used if import mode is updateIfMatchETag, in that case the import operation is performed only if this ETag matches the value maintained by the server.

import_mode: str or <xref:protocol.models.enum>

Required

The type of registry operation and ETag preferences. Possible values include: 'create', 'update', 'updateIfMatchETag', 'delete', 'deleteIfMatchETag', 'updateTwin', 'updateTwinIfMatchETag'

status: str or <xref:protocol.models.enum>

Required

The status of the module. If disabled, the module cannot connect to the service. Possible values include: 'enabled', 'disabled'

status_reason: str

Required

The 128 character-long string that stores the reason for the device identity status. All UTF-8 characters are allowed.

authentication: AuthenticationMechanism

Required

The authentication mechanism used by the module. This parameter is optional and defaults to SAS if not provided. In that case, primary/secondary access keys are auto-generated.

twin_etag: str

Required

The string representing a weak ETag for the device twin RFC7232. The value is only used if import mode is updateIfMatchETag, in that case the import operation is performed only if this ETag matches the value maintained by the server.