Twin Clase

Información de estado de un dispositivo o módulo. Esto se crea y elimina implícitamente cuando se crea o elimina la identidad del dispositivo o módulo correspondiente en el IoT Hub.

Herencia

Model

Twin

Constructor

Twin(*, device_id: str = None, module_id: str = None, tags=None, properties=None, etag: str = None, version: int = None, device_etag: str = None, status=None, status_reason: str = None, status_update_time=None, connection_state=None, last_activity_time=None, cloud_to_device_message_count: int = None, authentication_type=None, x509_thumbprint=None, capabilities=None, device_scope: str = None, parent_scopes=None, **kwargs)

Parámetros

device_id

str

Requerido

Identificador único del dispositivo en el registro de identidad del IoT Hub. Es una cadena que distingue mayúsculas de minúsculas (hasta 128 caracteres) de caracteres alfanuméricos de ASCII de 7 bits, y los siguientes caracteres especiales {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.

module_id

str

Requerido

Identificador único del módulo en el registro de identidad del IoT Hub. Es una cadena que distingue mayúsculas de minúsculas (hasta 128 caracteres) de caracteres alfanuméricos de ASCII de 7 bits, y los siguientes caracteres especiales {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.

tags

dict[str, object]

Requerido

Colección de pares clave-valor leídos y escritos por el back-end de la solución. No son visibles para las aplicaciones de dispositivo. Las claves están codificadas con UTF-8, distinguen mayúsculas de minúsculas y tienen una longitud de hasta 1 KB. Los caracteres permitidos excluyen caracteres de control UNICODE (segmentos C0 y C1), ".", "$" y espacio. Los valores son objetos JSON, de hasta 4 KB de longitud.

properties

TwinProperties

Requerido

Las propiedades deseadas y notificadas del gemelo.

etag

str

Requerido

Cadena que representa una ETag para el dispositivo gemelo, según RFC7232.

version

<xref:long>

Requerido

La versión del dispositivo gemelo, incluidas las etiquetas y las propiedades deseadas

device_etag

str

Requerido

Cadena que representa una ETag para el dispositivo, según RFC7232.

status

str o <xref:protocol.models.enum>

Requerido

Estado habilitado del dispositivo. Si está deshabilitado, el dispositivo no puede conectarse al servicio. Entre los valores posibles se incluyen: "enabled", "disabled"

status_reason

str

Requerido

Motivo del estado actual del dispositivo, si existe.

status_update_time

datetime

Requerido

Fecha y hora en que se actualizó por última vez el estado del dispositivo.

connection_state

str o <xref:protocol.models.enum>

Requerido

Estado de conexión del dispositivo. Entre los valores posibles se incluyen: "Disconnected", "Connected"

last_activity_time

datetime

Requerido

Fecha y hora en que el dispositivo se conectó por última vez o recibió o envió un mensaje. La fecha y hora se especifican en formato datetime ISO8601 en UTC, por ejemplo, 2015-01-28T16:24:48.789Z. Este valor no se actualiza si el dispositivo usa el protocolo HTTP/1 para realizar operaciones de mensajería.

cloud_to_device_message_count

int

Requerido

Número de mensajes de nube a dispositivo enviados.

authentication_type

str o <xref:protocol.models.enum>

Requerido

Tipo de autenticación usado por el dispositivo. Entre los valores posibles se incluyen: "sas", "selfSigned", "certificateAuthority", "none"

x509_thumbprint

X509Thumbprint

Requerido

Huella digital X509 del dispositivo.

capabilities

DeviceCapabilities

Requerido

device_scope

str

Requerido

El ámbito del dispositivo.

parent_scopes

list[str]

Requerido

Los ámbitos de los dispositivos perimetrales de nivel superior, si procede. Solo está disponible para dispositivos perimetrales.

Métodos

as_dict	Devuelve un dict que puede ser JSONify mediante json.dump. El uso avanzado puede usar opcionalmente una devolución de llamada como parámetro: Key es el nombre de atributo que se usa en Python. Attr_desc es un dict de metadatos. Actualmente contiene 'type' con el tipo msrest y 'key' con la clave codificada restAPI. Value es el valor actual de este objeto. La cadena devuelta se usará para serializar la clave. Si el tipo de valor devuelto es una lista, se considera una diferencia de resultado jerárquica. Vea los tres ejemplos de este archivo: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Si desea serialización XML, puede pasar los kwargs is_xml=True.
deserialize	Analice una cadena mediante la sintaxis restAPI y devuelva un modelo.
enable_additional_properties_sending
from_dict	Analizar un dict mediante un extractor de claves dado devuelve un modelo. De forma predeterminada, considere la posibilidad de extractores de claves (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor y last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Devuelve el JSON que se enviaría a Azure desde este modelo. Se trata de un alias para as_dict(full_restapi_key_transformer, keep_readonly=False). Si desea serialización XML, puede pasar los kwargs is_xml=True.
validate	Valide este modelo de forma recursiva y devuelva una lista de ValidationError.

as_dict

Devuelve un dict que puede ser JSONify mediante json.dump.

El uso avanzado puede usar opcionalmente una devolución de llamada como parámetro:

Key es el nombre de atributo que se usa en Python. Attr_desc es un dict de metadatos. Actualmente contiene 'type' con el tipo msrest y 'key' con la clave codificada restAPI. Value es el valor actual de este objeto.

La cadena devuelta se usará para serializar la clave. Si el tipo de valor devuelto es una lista, se considera una diferencia de resultado jerárquica.

Vea los tres ejemplos de este archivo:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Si desea serialización XML, puede pasar los kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parámetros

key_transformer

<xref:function>

Función de transformador de teclas.

keep_readonly

valor predeterminado: True

Devoluciones

Un objeto compatible con JSON dict

Tipo de valor devuelto

dict

deserialize

Analice una cadena mediante la sintaxis restAPI y devuelva un modelo.

deserialize(data, content_type=None)

Parámetros

data

str

Requerido

Una cadena de datos mediante la estructura restAPI. JSON de forma predeterminada.

content_type

str

valor predeterminado: None

JSON de forma predeterminada, establezca application/xml si XML.

Devoluciones

Instancia de este modelo

Excepciones

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analizar un dict mediante un extractor de claves dado devuelve un modelo.

De forma predeterminada, considere la posibilidad de extractores de claves (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor y last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parámetros

data

dict

Requerido

Un dict mediante la estructura restAPI

content_type

str

valor predeterminado: None

JSON de forma predeterminada, establezca application/xml si XML.

key_extractors

valor predeterminado: None

Devoluciones

Instancia de este modelo

Excepciones

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Devuelve el JSON que se enviaría a Azure desde este modelo.

Se trata de un alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Si desea serialización XML, puede pasar los kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parámetros

keep_readonly

bool

valor predeterminado: False

Si desea serializar los atributos de solo lectura

Devoluciones

Un objeto compatible con JSON dict

Tipo de valor devuelto

dict

validate

Valide este modelo de forma recursiva y devuelva una lista de ValidationError.

validate()

Devoluciones

Una lista de errores de validación

Tipo de valor devuelto

list