Module Classe

A identidade do módulo num 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

Necessário

O identificador exclusivo do módulo.

managed_by

str

Necessário

Identifica quem gere este módulo. Por exemplo, este valor é "IotEdge" se o runtime edge for proprietário deste módulo.

device_id

str

Necessário

O identificador exclusivo do dispositivo.

generation_id

str

Necessário

A cadeia Hub IoT gerada, sensível às maiúsculas e minúsculas, com até 128 carateres de comprimento. Este valor é utilizado para distinguir módulos com o mesmo moduleId, quando foram eliminados e recriados.

etag

str

Necessário

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

connection_state

str ou <xref:protocol.models.enum>

Necessário

O estado de ligação do dispositivo. Os valores possíveis incluem: "Desligado", "Ligado"

connection_state_updated_time

datetime

Necessário

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

last_activity_time

datetime

Necessário

A data e hora em que o dispositivo foi ligado pela última vez, recebeu ou enviou uma mensagem.

cloud_to_device_message_count

int

Necessário

O número de mensagens da cloud para o módulo atualmente em fila para serem enviadas para o módulo.

authentication

AuthenticationMechanism

Necessário

O mecanismo de autenticação utilizado pelo módulo ao ligar ao serviço e ao hub edge.

Métodos

as_dict	Devolver um ditado que pode ser JSONify com json.dump. Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro: A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto. A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico. Veja os três exemplos neste ficheiro: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se quiser serialização XML, pode transmitir os kwargs is_xml=True.
deserialize	Analise um str com a sintaxe RestAPI e devolva um modelo.
enable_additional_properties_sending
from_dict	Analisar um ditado com um determinado extrator de chaves devolve um modelo. Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Devolver o JSON que seria enviado para o Azure a partir deste modelo. Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso). Se quiser serialização XML, pode transmitir os kwargs is_xml=True.
validate	Valide este modelo de forma recursiva e devolva uma lista de ValidationError.

as_dict

Devolver um ditado que pode ser JSONify com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico.

Veja os três exemplos neste ficheiro:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se quiser serialização XML, pode transmitir 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 chaves.

keep_readonly

valor predefinido: True

Devoluções

Um objeto compatível com JSON de ditado

Tipo de retorno

dict

deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.

deserialize(data, content_type=None)

Parâmetros

data

str

Necessário

Um str com a estrutura RestAPI. JSON por predefinição.

content_type

str

valor predefinido: None

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

Devoluções

Uma instância deste modelo

Exceções

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores 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

Necessário

Um ditado com a estrutura restAPI

content_type

str

valor predefinido: None

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

key_extractors

valor predefinido: None

Devoluções

Uma instância deste modelo

Exceções

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Devolver o JSON que seria enviado para o Azure a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parâmetros

keep_readonly

bool

valor predefinido: False

Se quiser serializar os atributos só de leitura

Devoluções

Um objeto compatível com JSON de ditado

Tipo de retorno

dict

validate

Valide este modelo de forma recursiva e devolva uma lista de ValidationError.

validate()

Devoluções

Uma lista de erros de validação

Tipo de retorno

list