DevicesOperations Classe

Operações de operações de operações de dispositivos.

Herança

builtins.object

DevicesOperations

Construtor

DevicesOperations(client, config, serializer, deserializer)

Parâmetros

client

Necessário

Cliente para pedidos de serviço.

config

Necessário

Configuração do cliente de serviço.

serializer

Necessário

Um serializador modelo de objeto.

deserializer

Necessário

Um deserializador 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 registo de identidade do Hub IoT.
delete_identity	Elimina a identidade de um dispositivo do registo de identidade do Hub IoT.
get_devices	Obtém as identidades de vários dispositivos do registo de identidade Hub IoT. Não recomendada. Utilize a Hub IoT consulta API para recuperar informações de identidade de dois e dispositivos 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 mais informações.
get_identity	Obtém um dispositivo do registo de identidade do Hub IoT.
get_twin	Fica com 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 num dispositivo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods para obter mais informações.
replace_twin	Substitui as etiquetas 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 etiquetas 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 registo 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

Necessário

O identificador único do dispositivo.

device

Device

Necessário

O conteúdo da identidade do dispositivo.

if_match

str

valor predefinido: None

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

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config

Necessário

A configuração da operação sobrepõe-se.

Devoluções

Dispositivo ou ClienteRawResponse se cru=verdadeiro

Tipo de retorno

Device,

ClientRawResponse

Exceções

HttpOperationError

delete_identity

Elimina a identidade de um dispositivo do registo de identidade do Hub IoT.

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

Parâmetros

id

str

Necessário

O identificador único do dispositivo.

if_match

str

valor predefinido: None

A cadeia que representa um ETag fraco para a identidade do dispositivo, de acordo com RFC7232. A operação de eliminação só é realizada se este ETag corresponder ao valor mantido pelo servidor, indicando que a identidade do dispositivo não foi modificada desde que foi recuperada pela última vez. Para forçar uma eliminação incondicional, desempare If-Match ao carácter wildcard (*).

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config

Necessário

A configuração da operação sobrepõe-se.

Devoluções

Nenhum ou ClienteRawResponse se cru=verdadeiro

Tipo de retorno

None,

ClientRawResponse

Exceções

HttpOperationError

get_devices

Obtém as identidades de vários dispositivos do registo de identidade Hub IoT. Não recomendada. Utilize a Hub IoT consulta API para recuperar informações de identidade de dois e dispositivos 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 mais informações.

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

Parâmetros

top

int

valor predefinido: None

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

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config

Necessário

A configuração da operação sobrepõe-se.

Devoluções

lista ou ClienteRawResponse se cru=verdadeiro

Tipo de retorno

list[Device],

ClientRawResponse

Exceções

HttpOperationError

get_identity

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

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

Parâmetros

id

str

Necessário

O identificador único do dispositivo.

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config

Necessário

A configuração da operação sobrepõe-se.

Devoluções

Dispositivo ou ClienteRawResponse se cru=verdadeiro

Tipo de retorno

Device,

ClientRawResponse

Exceções

HttpOperationError

get_twin

Fica com 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

Necessário

O identificador único do dispositivo.

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config

Necessário

A configuração da operação sobrepõe-se.

Devoluções

Twin ou ClientRawResponse se cru=verdadeiro

Tipo de retorno

Twin,

ClientRawResponse

Exceções

HttpOperationError

invoke_method

Invoca um método direto num 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

Necessário

O identificador único do dispositivo.

direct_method_request

CloudToDeviceMethod

Necessário

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

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config

Necessário

A configuração da operação sobrepõe-se.

Devoluções

CloudToDeviceMethodResult ou ClientRawResponse se cru=verdadeiro

Tipo de retorno

CloudToDeviceMethodResult,

ClientRawResponse

Exceções

HttpOperationError

replace_twin

Substitui as etiquetas 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

Necessário

O identificador único do dispositivo.

device_twin_info

Twin

Necessário

A informação gémea do dispositivo que substituirá a informação existente.

if_match

str

valor predefinido: None

A corda que representa um ETag fraco para o twin do dispositivo, de acordo com RFC7232. Determina se a operação de substituição deve ser efetuada.

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config

Necessário

A configuração da operação sobrepõe-se.

Devoluções

Twin ou ClientRawResponse se cru=verdadeiro

Tipo de retorno

Twin,

ClientRawResponse

Exceções

HttpOperationError

update_twin

Atualizações as etiquetas 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

Necessário

O identificador único do dispositivo.

device_twin_info

Twin

Necessário

A informação dupla do dispositivo que contém as etiquetas e as propriedades desejadas deve ser atualizada.

if_match

str

valor predefinido: None

A corda que representa um ETag fraco para o twin do dispositivo, de acordo com RFC7232. Determina se a operação de atualização deve ser efetuada.

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta ao lado da resposta deserizada

operation_config

Necessário

A configuração da operação sobrepõe-se.

Devoluções

Twin ou ClientRawResponse se cru=verdadeiro

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