DevicesOperations Classe

Operações DevicesOperations.

Herança

builtins.object

DevicesOperations

Construtor

DevicesOperations(client, config, serializer, deserializer)

Parâmetros

client

Obrigatório

Cliente para solicitações de serviço.

config

Obrigatório

Configuração do cliente de serviço.

serializer

Obrigatório

Um serializador de modelo de objeto.

deserializer

Obrigatório

Um desserializador de modelo de objeto.

Variáveis

api_version

Versão da API. Valor constante: "2021-04-12".

Métodos

create_or_update_identity	Cria ou atualiza a identidade de um dispositivo no registro de identidade do Hub IoT.
delete_identity	Exclui a identidade de um dispositivo do registro de identidade do Hub IoT.
get_devices	Obtém as identidades de vários dispositivos do registro de identidade Hub IoT. Não recomendado. Use a API de consulta Hub IoT para recuperar informações de identidade do dispositivo gêmeo e do dispositivo. Consulte https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub e https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language para obter mais informações.
get_identity	Obtém um dispositivo do registro de identidade do Hub IoT.
get_twin	Obtém o dispositivo gêmeo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obter mais informações.
invoke_method	Invoca um método direto em um dispositivo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods para obter mais informações.
replace_twin	Substitui as marcas e as propriedades desejadas de um dispositivo gêmeo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obter mais informações.
update_twin	Atualizações as marcas e as propriedades desejadas de um dispositivo gêmeo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obter mais informações.

create_or_update_identity

Cria ou atualiza a identidade de um dispositivo no registro de identidade do Hub IoT.

create_or_update_identity(id, device, if_match=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

id

str

Obrigatório

O identificador exclusivo do dispositivo.

device

Device

Obrigatório

O conteúdo da identidade do dispositivo.

if_match

str

valor padrão: None

A cadeia de caracteres que representa uma ETag fraca para a identidade do dispositivo, de acordo com RFC7232. Isso não deve ser definido ao criar um dispositivo, mas pode ser definido ao atualizar um dispositivo.

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

Device ou ClientRawResponse se raw=true

Tipo de retorno

Device,

ClientRawResponse

Exceções

HttpOperationError

delete_identity

Exclui a identidade de um dispositivo do registro de identidade do Hub IoT.

delete_identity(id, if_match=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

id

str

Obrigatório

O identificador exclusivo do dispositivo.

if_match

str

valor padrão: None

A cadeia de caracteres que representa uma ETag fraca para a identidade do dispositivo, de acordo com RFC7232. A operação de exclusão será executada somente se essa ETag corresponder ao valor mantido pelo servidor, indicando que a identidade do dispositivo não foi modificada desde a última recuperação. Para forçar uma exclusão incondicional, defina If-Match como o caractere curinga (*).

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

HttpOperationError

get_devices

Obtém as identidades de vários dispositivos do registro de identidade Hub IoT. Não recomendado. Use a API de consulta Hub IoT para recuperar informações de identidade do dispositivo gêmeo e do dispositivo. Consulte https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub e https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language para obter mais informações.

get_devices(top=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

top

int

valor padrão: None

O número máximo de identidades de dispositivo retornadas pela consulta. Qualquer valor fora do intervalo de 1-1000 é considerado 1000.

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

list ou ClientRawResponse se raw=true

Tipo de retorno

list[Device],

ClientRawResponse

Exceções

HttpOperationError

get_identity

Obtém um dispositivo do registro de identidade do Hub IoT.

get_identity(id, custom_headers=None, raw=False, **operation_config)

Parâmetros

id

str

Obrigatório

O identificador exclusivo do dispositivo.

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

Device ou ClientRawResponse se raw=true

Tipo de retorno

Device,

ClientRawResponse

Exceções

HttpOperationError

get_twin

Obtém o dispositivo gêmeo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obter mais informações.

get_twin(id, custom_headers=None, raw=False, **operation_config)

Parâmetros

id

str

Obrigatório

O identificador exclusivo do dispositivo.

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

Twin ou ClientRawResponse se raw=true

Tipo de retorno

Twin,

ClientRawResponse

Exceções

HttpOperationError

invoke_method

Invoca um método direto em um dispositivo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods para obter mais informações.

invoke_method(device_id, direct_method_request, custom_headers=None, raw=False, **operation_config)

Parâmetros

device_id

str

Obrigatório

O identificador exclusivo do dispositivo.

direct_method_request

CloudToDeviceMethod

Obrigatório

Os parâmetros para executar um método direto no dispositivo.

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

CloudToDeviceMethodResult ou ClientRawResponse se raw=true

Tipo de retorno

CloudToDeviceMethodResult,

ClientRawResponse

Exceções

HttpOperationError

replace_twin

Substitui as marcas e as propriedades desejadas de um dispositivo gêmeo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obter mais informações.

replace_twin(id, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

id

str

Obrigatório

O identificador exclusivo do dispositivo.

device_twin_info

Twin

Obrigatório

As informações do dispositivo gêmeo que substituirão as informações existentes.

if_match

str

valor padrão: None

A cadeia de caracteres que representa uma ETag fraca para o dispositivo gêmeo, de acordo com RFC7232. Ele determina se a operação de substituição deve ser executada.

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

Twin ou ClientRawResponse se raw=true

Tipo de retorno

Twin,

ClientRawResponse

Exceções

HttpOperationError

update_twin

Atualizações as marcas e as propriedades desejadas de um dispositivo gêmeo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obter mais informações.

update_twin(id, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

id

str

Obrigatório

O identificador exclusivo do dispositivo.

device_twin_info

Twin

Obrigatório

As informações do dispositivo gêmeo que contêm as marcas e as propriedades desejadas a serem atualizadas.

if_match

str

valor padrão: None

A cadeia de caracteres que representa uma ETag fraca para o dispositivo gêmeo, de acordo com RFC7232. Ele determina se a operação de atualização deve ser executada.

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

Twin ou ClientRawResponse se raw=true

Tipo de retorno

Twin,

ClientRawResponse

Exceções

HttpOperationError

Atributos

models

models = <module 'azure.iot.hub.protocol.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\iot\\hub\\protocol\\models\\__init__.py'>