Compartilhar via

ModulesOperations Classe

  • Referência

Operações ModulesOperations.

Herança
builtins.object
ModulesOperations

Construtor

ModulesOperations(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 do módulo para um dispositivo no Hub IoT. A moduleId e a generationId não podem ser atualizadas pelo usuário.
delete_identity

Exclui a identidade do módulo de um dispositivo no 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

Obtém 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 em um 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 marcas 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 marcas 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 no Hub IoT. A moduleId e a generationId não podem ser atualizadas pelo usuário.

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

Parâmetros

id
str
Obrigatório

O identificador exclusivo do dispositivo.

mid
str
Obrigatório

O identificador exclusivo do módulo.

module
Module
Obrigatório

A identidade do módulo.

if_match
str
valor padrão: None

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

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

Module ou ClientRawResponse se raw=true

Tipo de retorno

Module,
ClientRawResponse

Exceções

HttpOperationError

delete_identity

Exclui a identidade do módulo de um dispositivo no Hub IoT.

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

Parâmetros

id
str
Obrigatório

O identificador exclusivo do deivce.

mid
str
Obrigatório

O identificador exclusivo do módulo.

if_match
str
valor padrão: None

A cadeia de caracteres que representa uma ETag fraca para o módulo, de acordo com RFC7232. A operação de exclusão será executada somente se essa 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 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_identity

Obtém uma identidade de módulo no dispositivo.

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

Parâmetros

id
str
Obrigatório

O identificador exclusivo do dispositivo.

mid
str
Obrigatório

O identificador exclusivo do módulo.

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

Module ou ClientRawResponse se raw=true

Tipo de retorno

Module,
ClientRawResponse

Exceções

HttpOperationError

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

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

list ou ClientRawResponse se raw=true

Tipo de retorno

list[Module],
ClientRawResponse

Exceções

HttpOperationError

get_twin

Obtém 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

id
str
Obrigatório

O identificador exclusivo do dispositivo.

mid
str
Obrigatório

O identificador exclusivo do módulo.

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

device_id
str
Obrigatório

O identificador exclusivo do dispositivo.

module_id
str
Obrigatório

O identificador exclusivo do módulo.

direct_method_request
CloudToDeviceMethod
Obrigatório

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

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

id
str
Obrigatório

O identificador exclusivo do dispositivo.

mid
str
Obrigatório

O identificador exclusivo do módulo.

device_twin_info
Twin
Obrigatório

As informações do módulo 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 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

id
str
Obrigatório

O identificador exclusivo do dispositivo.

mid
str
Obrigatório

O identificador exclusivo do módulo.

device_twin_info
Twin
Obrigatório

As informações do módulo 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'>