ExportImportDevice Clase

ExportImportDevice.

Herencia

Model

ExportImportDevice

Constructor

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

Parámetros

id

str

Requerido

Identificador único del dispositivo.

module_id

str

Requerido

Identificador único del módulo, si procede.

e_tag

str

Requerido

Cadena que representa una ETag débil para el dispositivo RFC7232. El valor solo se usa si el modo de importación es updateIfMatchETag, en ese caso, la operación de importación solo se realiza si esta ETag coincide con el valor mantenido por el servidor.

import_mode

str o <xref:protocol.models.enum>

Requerido

El tipo de operación del Registro y las preferencias de ETag. Entre los valores posibles se incluyen: 'create', 'update', 'updateIfMatchETag', 'deleteIfMatchETag', 'updateTwin', 'updateTwinIfMatchETag'

status

str o <xref:protocol.models.enum>

Requerido

Estado del módulo. Si está deshabilitado, el módulo no se puede conectar al servicio. Entre los valores posibles se incluyen: "enabled", "disabled"

status_reason

str

Requerido

Cadena de 128 caracteres de longitud que almacena el motivo del estado de identidad del dispositivo. Se permiten todos los caracteres UTF-8.

authentication

AuthenticationMechanism

Requerido

Mecanismo de autenticación utilizado por el módulo. Este parámetro es opcional y el valor predeterminado es SAS si no se proporciona. En ese caso, las claves de acceso principal/secundaria se generan automáticamente.

twin_etag

str

Requerido

Cadena que representa una ETag débil para el dispositivo gemelo RFC7232. El valor solo se usa si el modo de importación es updateIfMatchETag, en ese caso, la operación de importación solo se realiza si esta ETag coincide con el valor mantenido por el servidor.

tags

dict[str, object]

Requerido

El documento JSON leído y escrito por el back-end de la solución. Las etiquetas no son visibles para las aplicaciones de dispositivo.

properties

PropertyContainer

Requerido

Propiedades deseadas y notificadas para el dispositivo.

capabilities

DeviceCapabilities

Requerido

Estado de las funcionalidades habilitadas en el dispositivo.

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 podría 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 dict de resultados jerárquicos. Consulte 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 podría 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 dict de resultados jerárquicos.

Consulte 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>

Una 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

Una 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

Una 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