Device Classe

Dispositivo.

Herança

Model

Device

Construtor

Device(*, device_id: str = None, generation_id: str = None, etag: str = None, connection_state=None, status=None, status_reason: str = None, connection_state_updated_time=None, status_updated_time=None, last_activity_time=None, cloud_to_device_message_count: int = None, authentication=None, capabilities=None, device_scope: str = None, parent_scopes=None, **kwargs)

Parâmetros

device_id

str

Necessário

O identificador exclusivo do dispositivo.

generation_id

str

Necessário

A cadeia Hub IoT gerada por maiúsculas e minúsculas com até 128 carateres. Este valor é utilizado para distinguir dispositivos com o mesmo deviceId, quando foram eliminados e recriados.

etag

str

Necessário

A cadeia que representa um ETag fraco para a identidade do dispositivo, de acordo com RFC7232.

connection_state

str ou <xref:protocol.models.enum>

Necessário

O estado do dispositivo. Os valores possíveis incluem: "Desligado", "Ligado"

status

str ou <xref:protocol.models.enum>

Necessário

O estado do dispositivo. Se o estado estiver desativado, um dispositivo não poderá ligar ao serviço. Os valores possíveis incluem: "ativado", "desativado"

status_reason

str

Necessário

A cadeia de carateres com 128 carateres que armazena o motivo do estado da identidade do dispositivo. Todos os carateres UTF-8 são permitidos.

connection_state_updated_time

datetime

Necessário

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

status_updated_time

datetime

Necessário

A data e hora em que o campo de estado foi atualizado pela última vez.

last_activity_time

datetime

Necessário

A data e a última vez que o dispositivo ligou, recebeu ou enviou uma mensagem.

cloud_to_device_message_count

int

Necessário

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

authentication

AuthenticationMechanism

Necessário

O mecanismo de autenticação utilizado pelo dispositivo.

capabilities

DeviceCapabilities

Necessário

O conjunto de capacidades do dispositivo. Por exemplo, se este dispositivo for ou não um dispositivo edge.

device_scope

str

Necessário

O âmbito do dispositivo. Gerado automaticamente e imutável para dispositivos edge e modificável em dispositivos de folha para criar uma relação subordinada/principal.

parent_scopes

list[str]

Necessário

Os âmbitos dos dispositivos edge de nível superior, se aplicável. Apenas disponível para dispositivos edge.

Métodos

as_dict	Devolva 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. Valor é o valor atual neste objeto. A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, este é considerado ditado 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 passar 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	Devolva 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 passar os kwargs is_xml=True.
validate	Valide este modelo de forma recursiva e devolva uma lista de ValidationError.

as_dict

Devolva 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. Valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, este é considerado ditado 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 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 chaves.

keep_readonly

valor predefinido: True

Devoluções

Um objeto compatível com JSON de dict

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 aplicação/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 aplicação/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

Devolva 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 passar 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 dict

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