ModulesOperations Classe
Módulos Operações de operações.
- Herança
-
builtins.objectModulesOperations
Construtor
ModulesOperations(client, config, serializer, deserializer)Parâmetros
- client
Cliente para pedidos de serviço.
- config
Configuração do cliente de serviço.
- serializer
Um serializador modelo de objeto.
- deserializer
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 do módulo para um dispositivo na Hub IoT. O móduloId e geraçãoId não pode ser atualizado pelo utilizador. |
| delete_identity |
Elimina a identidade do módulo para um dispositivo na Hub IoT. |
| get_identity |
Obtém uma identidade de módulo no dispositivo. |
| get_modules_on_device |
Obtém todas as identidades do módulo no dispositivo. |
| get_twin |
Fica com o módulo 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 módulo de um 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 módulo 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 módulo 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 do módulo para um dispositivo na Hub IoT. O móduloId e geraçãoId não pode ser atualizado pelo utilizador.
create_or_update_identity(id, mid, module, if_match=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- if_match
- str
A corda que representa um ETag fraco para o módulo, de acordo com RFC7232. Isto não deve ser definido ao criar um módulo, mas pode ser definido ao atualizar um módulo.
- operation_config
A configuração da operação sobrepõe-se.
Devoluções
Módulo ou ClienteRawResponse se cru=verdadeiro
Tipo de retorno
Exceções
delete_identity
Elimina a identidade do módulo para um dispositivo na Hub IoT.
delete_identity(id, mid, if_match=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- if_match
- str
A corda que representa um ETag fraco para o módulo, de acordo com RFC7232. A operação de eliminação só é realizada se este ETag corresponder ao valor mantido pelo servidor, indicando que o módulo não foi modificado desde que foi recuperado pela última vez. Para forçar uma eliminação incondicional, desempare If-Match ao carácter wildcard (*).
- operation_config
A configuração da operação sobrepõe-se.
Devoluções
Nenhum ou ClienteRawResponse se cru=verdadeiro
Tipo de retorno
Exceções
get_identity
Obtém uma identidade de módulo no dispositivo.
get_identity(id, mid, custom_headers=None, raw=False, **operation_config)Parâmetros
- operation_config
A configuração da operação sobrepõe-se.
Devoluções
Módulo ou ClienteRawResponse se cru=verdadeiro
Tipo de retorno
Exceções
get_modules_on_device
Obtém todas as identidades do módulo no dispositivo.
get_modules_on_device(id, custom_headers=None, raw=False, **operation_config)Parâmetros
- operation_config
A configuração da operação sobrepõe-se.
Devoluções
lista ou ClienteRawResponse se cru=verdadeiro
Tipo de retorno
Exceções
get_twin
Fica com o módulo gémeo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obter mais informações.
get_twin(id, mid, custom_headers=None, raw=False, **operation_config)Parâmetros
- operation_config
A configuração da operação sobrepõe-se.
Devoluções
Twin ou ClientRawResponse se cru=verdadeiro
Tipo de retorno
Exceções
invoke_method
Invoca um método direto num módulo de um dispositivo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods para obter mais informações.
invoke_method(device_id, module_id, direct_method_request, custom_headers=None, raw=False, **operation_config)Parâmetros
- direct_method_request
- CloudToDeviceMethod
Os parâmetros para executar um método direto no módulo.
- operation_config
A configuração da operação sobrepõe-se.
Devoluções
CloudToDeviceMethodResult ou ClientRawResponse se cru=verdadeiro
Tipo de retorno
Exceções
replace_twin
Substitui as etiquetas e as propriedades desejadas de um módulo gémeo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obter mais informações.
replace_twin(id, mid, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- device_twin_info
- Twin
A informação gémea do módulo que substituirá a informação existente.
- if_match
- str
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.
- operation_config
A configuração da operação sobrepõe-se.
Devoluções
Twin ou ClientRawResponse se cru=verdadeiro
Tipo de retorno
Exceções
update_twin
Atualizações as etiquetas e as propriedades desejadas de um módulo gémeo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obter mais informações.
update_twin(id, mid, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- device_twin_info
- Twin
A informação dupla do módulo que contém as etiquetas e propriedades desejadas deve ser atualizada.
- if_match
- str
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.
- operation_config
A configuração da operação sobrepõe-se.
Devoluções
Twin ou ClientRawResponse se cru=verdadeiro
Tipo de retorno
Exceções
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'>
Azure SDK for Python