Module Classe

A identidade do módulo em um dispositivo.

Herança

Model

Module

Construtor

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

Parâmetros

module_id

str

Obrigatório

O identificador exclusivo do módulo.

managed_by

str

Obrigatório

Identifica quem gerencia este módulo. Por exemplo, esse valor será "IotEdge" se o runtime do Edge possuir este módulo.

device_id

str

Obrigatório

O identificador exclusivo do dispositivo.

generation_id

str

Obrigatório

O Hub IoT cadeia de caracteres com diferenciação de maiúsculas e minúsculas gerada com até 128 caracteres. Esse valor é usado para distinguir módulos com a mesma moduleId, quando eles foram excluídos e recriados.

etag

str

Obrigatório

A cadeia de caracteres que representa uma ETag fraca para a identidade do módulo, de acordo com RFC7232.

connection_state

str ou <xref:protocol.models.enum>

Obrigatório

O estado de conexão do dispositivo. Os valores possíveis incluem: 'Disconnected', 'Connected'

connection_state_updated_time

datetime

Obrigatório

A data e a hora em que o estado da conexão foi atualizado pela última vez.

last_activity_time

datetime

Obrigatório

A data e a hora em que o dispositivo se conectou, recebeu ou enviou uma mensagem pela última vez.

cloud_to_device_message_count

int

Obrigatório

O número de mensagens da nuvem para o módulo atualmente na fila a serem enviadas para o módulo.

authentication

AuthenticationMechanism

Obrigatório

O mecanismo de autenticação usado pelo módulo ao se conectar ao serviço e ao hub de borda.

Métodos

as_dict	Retornar um ditado que pode ser JSONify usando json.dump. Opcionalmente, o uso avançado pode usar um retorno de chamada como parâmetro: Key é o nome do atributo usado no Python. Attr_desc é um dict de metadados. Atualmente contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto . A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico. Confira os três exemplos neste arquivo: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
deserialize	Analise um str usando a sintaxe RestAPI e retorne um modelo.
enable_additional_properties_sending
from_dict	Analisar um ditado usando determinado extrator de chave retorna um modelo. Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Retorne o JSON que seria enviado para o azure desse modelo. Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False). Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
validate	Valide esse modelo recursivamente e retorne uma lista de ValidationError.

as_dict

Retornar um ditado que pode ser JSONify usando json.dump.

Opcionalmente, o uso avançado pode usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um dict de metadados. Atualmente contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto .

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

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

Parâmetros

key_transformer

<xref:function>

Uma função de transformador de chave.

keep_readonly

valor padrão: True

Retornos

Um objeto compatível com JSON de dict

Tipo de retorno

dict

deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.

deserialize(data, content_type=None)

Parâmetros

data

str

Obrigatório

Um str usando a estrutura RestAPI. JSON por padrão.

content_type

str

valor padrão: None

JSON por padrão, defina application/xml se XML.

Retornos

Uma instância desse modelo

Exceções

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

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

Parâmetros

data

dict

Obrigatório

Um ditado usando a estrutura RestAPI

content_type

str

valor padrão: None

JSON por padrão, defina application/xml se XML.

key_extractors

valor padrão: None

Retornos

Uma instância desse modelo

Exceções

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parâmetros

keep_readonly

bool

valor padrão: False

Se você quiser serializar os atributos somente leitura

Retornos

Um objeto compatível com JSON de dict

Tipo de retorno

dict

validate

Valide esse modelo recursivamente e retorne uma lista de ValidationError.

validate()

Retornos

Uma lista de erros de validação

Tipo de retorno

list