Compartilhar via


IoTHubModuleClient Classe

Um cliente de módulo síncrono que se conecta a uma instância do Hub IoT do Azure ou do Azure IoT Edge.

Inicializador para um IoTHubModuleClient.

Esse inicializador não deve ser chamado diretamente. Em vez disso, use um dos classmethods '>>create_from_<<' para instanciar

Herança
azure.iot.device.iothub.sync_clients.GenericIoTHubClient
IoTHubModuleClient
azure.iot.device.iothub.abstract_clients.AbstractIoTHubModuleClient
IoTHubModuleClient

Construtor

IoTHubModuleClient(mqtt_pipeline, http_pipeline)

Parâmetros

mqtt_pipeline
<xref:azure.iot.device.iothub.pipeline.MQTTPipeline>
Obrigatório

O pipeline usado para se conectar ao ponto de extremidade do IoTHub.

http_pipeline
<xref:azure.iot.device.iothub.pipeline.HTTPPipeline>
Obrigatório

O pipeline usado para se conectar ao ponto de extremidade do IoTHub por meio de HTTP.

Métodos

connect

Conecta o cliente a um Hub IoT do Azure ou a uma instância do Hub IoT Edge do Azure.

O destino é escolhido com base nas credenciais passadas por meio do parâmetro auth_provider que foi fornecido quando esse objeto foi inicializado.

Essa é uma chamada síncrona, o que significa que essa função não retornará até que a conexão com o serviço seja completamente estabelecida.

create_from_connection_string

Instancie o cliente de um dispositivo IoTHub ou uma cadeia de conexão de módulo.

create_from_edge_environment

Instancie o cliente do ambiente de IoT Edge.

Esse método só pode ser executado de dentro de um contêiner de IoT Edge ou em um ambiente de depuração configurado para desenvolvimento do Edge (por exemplo, Visual Studio, Visual Studio Code)

create_from_sastoken

Criar uma instância do cliente de uma cadeia de caracteres de token SAS pré-criada

create_from_x509_certificate

Instancie um cliente usando a autenticação de certificado X509.

disconnect

Desconecte o cliente do Hub IoT do Azure ou da instância do Hub IoT Edge do Azure.

É recomendável que você certifique-se de chamar essa função quando terminar completamente com a instância do cliente.

Essa é uma chamada síncrona, o que significa que essa função não retornará até que a conexão com o serviço seja completamente fechada.

get_twin

Obtém o dispositivo ou o módulo gêmeo do Hub IoT do Azure ou do serviço hub de IoT Edge do Azure.

Essa é uma chamada síncrona, o que significa que essa função não retornará até que o gêmeo seja recuperado do serviço.

invoke_method

Invoque um método do cliente em um cliente de dispositivo ou módulo e receba a resposta para a chamada de método.

patch_twin_reported_properties

Atualize as propriedades relatadas com o serviço Hub IoT do Azure ou Hub IoT Edge do Azure.

Essa é uma chamada síncrona, o que significa que essa função não retornará até que o patch seja enviado para o serviço e reconhecido.

Se o serviço retornar um erro na operação de patch, essa função gerará o erro apropriado.

receive_message_on_input

Receba uma mensagem de entrada que foi enviada de outro Módulo para uma entrada específica.

Preterido desde a versão 2.3.0: recomendamos que você use a propriedade .on_message_received para definir um manipulador

receive_method_request

Receba uma solicitação de método por meio do Hub IoT do Azure ou do Hub IoT Edge do Azure.

Preterido desde a versão 2.3.0: recomendamos que você use a propriedade .on_method_request_received para definir um manipulador

receive_twin_desired_properties_patch

Receba um patch de propriedade desejado por meio do Hub IoT do Azure ou hub de IoT Edge do Azure.

Essa é uma chamada síncrona, o que significa o seguinte:

  1. Se block=True, essa função será bloqueada até que ocorra um destes procedimentos:

    • um patch de propriedade desejado é recebido do Hub IoT do Azure ou do Hub IoT Edge do Azure.

    • o período de tempo limite, se fornecido, decorrido. Se um tempo limite acontecer, essa função gerará uma exceção InboxEmpty

  2. Se block=False, essa função retornará todos os patches de propriedade desejados que possam ter sido recebidos pelo pipeline, mas ainda não retornados ao aplicativo. Se nenhum patche de propriedade desejado tiver sido recebido pelo pipeline, essa função gerará uma exceção InboxEmpty

Preterido desde a versão 2.3.0: recomendamos que você use a propriedade .on_twin_desired_properties_patch_received para definir um manipulador

send_message

Envia uma mensagem para o ponto de extremidade de eventos padrão no Hub IoT do Azure ou na instância do Hub IoT Edge do Azure.

Esse é um evento síncrono, o que significa que essa função não retornará até que o evento tenha sido enviado ao serviço e o serviço tenha reconhecido o recebimento do evento.

Se a conexão com o serviço não tiver sido aberta anteriormente por uma chamada para se conectar, essa função abrirá a conexão antes de enviar o evento.

send_message_to_output

Envia um evento/mensagem para a saída do módulo fornecida.

Esses são eventos de saída e devem ser "eventos de saída".

Esse é um evento síncrono, o que significa que essa função não retornará até que o evento tenha sido enviado ao serviço e o serviço tenha reconhecido o recebimento do evento.

Se a conexão com o serviço não tiver sido aberta anteriormente por uma chamada para se conectar, essa função abrirá a conexão antes de enviar o evento.

send_method_response

Envie uma resposta a uma solicitação de método por meio do hub Hub IoT do Azure ou do Azure IoT Edge.

Esse é um evento síncrono, o que significa que essa função não retornará até que o evento tenha sido enviado ao serviço e o serviço tenha reconhecido o recebimento do evento.

Se a conexão com o serviço não tiver sido aberta anteriormente por uma chamada para se conectar, essa função abrirá a conexão antes de enviar o evento.

shutdown

Desligue o cliente para uma saída normal.

Depois que esse método for chamado, todas as tentativas em outras chamadas de cliente resultarão na geração de um ClientError

update_sastoken

Atualize o Token SAS do cliente usado para autenticação e, em seguida, reautorize a conexão.

Essa API só poderá ser usada se o cliente tiver sido criado inicialmente com um token SAS.

connect

Conecta o cliente a um Hub IoT do Azure ou a uma instância do Hub IoT Edge do Azure.

O destino é escolhido com base nas credenciais passadas por meio do parâmetro auth_provider que foi fornecido quando esse objeto foi inicializado.

Essa é uma chamada síncrona, o que significa que essa função não retornará até que a conexão com o serviço seja completamente estabelecida.

connect()

Exceções

se as credenciais forem inválidas e uma conexão não puder ser estabelecida.

se um estabelecimento de uma conexão resultar em falha.

se a conexão for perdida durante a execução.

se a conexão atingir o tempo limite.

se houver uma falha inesperada durante a execução.

create_from_connection_string

Instancie o cliente de um dispositivo IoTHub ou uma cadeia de conexão de módulo.

create_from_connection_string(connection_string, **kwargs)

Parâmetros

connection_string
str
Obrigatório

A cadeia de conexão para o IoTHub ao qual você deseja se conectar.

server_verification_cert
str
Obrigatório

Opção de configuração. A cadeia de certificados confiável. Necessário ao usar a conexão a um ponto de extremidade que tenha uma raiz de confiança não padrão, como um gateway de protocolo.

websockets
bool
Obrigatório

Opção de configuração. O padrão é Falso. Defina como true se estiver usando MQTT em websockets.

cipher
str ou list(str)
Obrigatório

Opção de configuração. Pacotes de criptografia para TLS/SSL, como uma cadeia de caracteres em "Formato de lista de criptografia OpenSSL" ou como uma lista de cadeias de caracteres de conjunto de criptografia.

product_info
str
Obrigatório

Opção de configuração. O padrão é uma cadeia de caracteres vazia. A cadeia de caracteres contém informações arbitrárias do produto que são acrescentadas à cadeia de caracteres do agente do usuário.

proxy_options
ProxyOptions
Obrigatório

Opções para enviar tráfego por meio de servidores proxy.

sastoken_ttl
int
Obrigatório

O tempo de vida (em segundos) para o SasToken criado usado para autenticação. O padrão é 3600 segundos (1 hora).

keep_alive
int
Obrigatório

Período máximo em segundos entre as comunicações com o agente. Se nenhuma outra mensagem estiver sendo trocada, isso controlará a taxa na qual o cliente enviará mensagens de ping ao agente. Se não for fornecido o valor padrão de 60 segundos, será usado.

auto_connect
bool
Obrigatório

Conecte automaticamente o cliente ao IoTHub quando um método é invocado, o que requer uma conexão a ser estabelecida. (Padrão: True)

connection_retry
bool
Obrigatório

Tentativa de restabelecer uma conexão descartada (Padrão: True)

connection_retry_interval
int
Obrigatório

Intervalo, em segundos, entre tentativas de restabelecer uma conexão descartada (Padrão: 10)

ensure_desired_properties
bool
Obrigatório

Verifique se o patch de propriedades desejadas mais recente foi recebido em novas conexões (Default:True)

Retornos

Uma instância de um cliente IoTHub que usa uma cadeia de conexão para autenticação.

Exceções

ValueError if given an invalid connection_string.
TypeError if given an unsupported parameter.

create_from_edge_environment

Instancie o cliente do ambiente de IoT Edge.

Esse método só pode ser executado de dentro de um contêiner de IoT Edge ou em um ambiente de depuração configurado para desenvolvimento do Edge (por exemplo, Visual Studio, Visual Studio Code)

create_from_edge_environment(**kwargs)

Parâmetros

websockets
bool
Obrigatório

Opção de configuração. O padrão é Falso. Defina como true se estiver usando MQTT em websockets.

cipher
str ou list(str)
Obrigatório

Opção de configuração. Pacotes de criptografia para TLS/SSL, como uma cadeia de caracteres em "Formato de lista de criptografia OpenSSL" ou como uma lista de cadeias de caracteres de conjunto de criptografia.

product_info
str
Obrigatório

Opção de configuração. O padrão é uma cadeia de caracteres vazia. A cadeia de caracteres contém informações arbitrárias do produto que são acrescentadas à cadeia de caracteres do agente do usuário.

proxy_options
ProxyOptions
Obrigatório

Opções para enviar tráfego por meio de servidores proxy.

sastoken_ttl
int
Obrigatório

O tempo de vida (em segundos) para o SasToken criado usado para autenticação. O padrão é 3600 segundos (1 hora)

keep_alive
int
Obrigatório

Período máximo em segundos entre as comunicações com o agente. Se nenhuma outra mensagem estiver sendo trocada, isso controlará a taxa na qual o cliente enviará mensagens de ping ao agente. Se não for fornecido o valor padrão de 60 segundos, será usado.

auto_connect
bool
Obrigatório

Conecte automaticamente o cliente ao IoTHub quando um método é invocado, o que requer uma conexão a ser estabelecida. (Padrão: True)

connection_retry
bool
Obrigatório

Tentativa de restabelecer uma conexão descartada (Padrão: True)

connection_retry_interval
int
Obrigatório

Intervalo, em segundos, entre tentativas de restabelecer uma conexão descartada (Padrão: 10)

Retornos

Uma instância de um cliente IoTHub que usa o ambiente IoT Edge para autenticação.

Exceções

OSError if the IoT Edge container is not configured correctly.
ValueError if debug variables are invalid.
TypeError if given an unsupported parameter.

create_from_sastoken

Criar uma instância do cliente de uma cadeia de caracteres de token SAS pré-criada

create_from_sastoken(sastoken, **kwargs)

Parâmetros

sastoken
str
Obrigatório

A cadeia de caracteres de token SAS

server_verification_cert
str
Obrigatório

Opção de configuração. A cadeia de certificados confiável. Necessário ao usar a conexão a um ponto de extremidade que tenha uma raiz de confiança não padrão, como um gateway de protocolo.

gateway_hostname
str
Obrigatório

Opção de configuração. O nome do host do gateway para o dispositivo de gateway.

websockets
bool
Obrigatório

Opção de configuração. O padrão é Falso. Defina como true se estiver usando MQTT em websockets.

cipher
str ou list(str)
Obrigatório

Opção de configuração. Pacotes de criptografia para TLS/SSL, como uma cadeia de caracteres em "Formato de lista de criptografia OpenSSL" ou como uma lista de cadeias de caracteres de conjunto de criptografia.

product_info
str
Obrigatório

Opção de configuração. O padrão é uma cadeia de caracteres vazia. A cadeia de caracteres contém informações arbitrárias do produto que são acrescentadas à cadeia de caracteres do agente do usuário.

proxy_options
ProxyOptions
Obrigatório

Opções para enviar tráfego por meio de servidores proxy.

keep_alive
int
Obrigatório

Período máximo em segundos entre as comunicações com o agente. Se nenhuma outra mensagem estiver sendo trocada, isso controlará a taxa na qual o cliente enviará mensagens de ping ao agente. Se não for fornecido o valor padrão de 60 segundos, será usado.

auto_connect
bool
Obrigatório

Conecte automaticamente o cliente ao IoTHub quando um método é invocado, o que requer uma conexão a ser estabelecida. (Padrão: True)

connection_retry
bool
Obrigatório

Tentativa de restabelecer uma conexão descartada (Padrão: True)

connection_retry_interval
int
Obrigatório

Intervalo, em segundos, entre tentativas de restabelecer uma conexão descartada (Padrão: 10)

ensure_desired_properties
bool
Obrigatório

Verifique se o patch de propriedades desejadas mais recente foi recebido em novas conexões (Default:True)

Exceções

TypeError if given an unsupported parameter.
ValueError if the sastoken parameter is invalid.

create_from_x509_certificate

Instancie um cliente usando a autenticação de certificado X509.

create_from_x509_certificate(x509, hostname, device_id, module_id, **kwargs)

Parâmetros

hostname
str
Obrigatório

Host executando o IotHub. Pode ser encontrado no portal do Azure na guia Visão geral como o nome do host da cadeia de caracteres.

x509
X509
Obrigatório

O objeto de certificado x509 completo. Para usar o certificado, o objeto de registro precisa conter certificado (o certificado raiz ou um dos certificados de AC intermediários). Se o certificado for proveniente de um arquivo CER, ele precisará ser codificado em base64.

device_id
str
Obrigatório

A ID usada para identificar exclusivamente um dispositivo no IoTHub

module_id
str
Obrigatório

A ID usada para identificar exclusivamente um módulo em um dispositivo no IoTHub.

server_verification_cert
str
Obrigatório

Opção de configuração. A cadeia de certificados confiável. Necessário ao usar a conexão a um ponto de extremidade que tenha uma raiz de confiança não padrão, como um gateway de protocolo.

gateway_hostname
str
Obrigatório

Opção de configuração. O nome do host do gateway para o dispositivo de gateway.

websockets
bool
Obrigatório

Opção de configuração. O padrão é Falso. Defina como true se estiver usando MQTT em websockets.

cipher
str ou list(str)
Obrigatório

Opção de configuração. Pacotes de criptografia para TLS/SSL, como uma cadeia de caracteres em "Formato de lista de criptografia OpenSSL" ou como uma lista de cadeias de caracteres de conjunto de criptografia.

product_info
str
Obrigatório

Opção de configuração. O padrão é uma cadeia de caracteres vazia. A cadeia de caracteres contém informações arbitrárias do produto que são acrescentadas à cadeia de caracteres do agente do usuário.

proxy_options
ProxyOptions
Obrigatório

Opções para enviar tráfego por meio de servidores proxy.

keep_alive
int
Obrigatório

Período máximo em segundos entre as comunicações com o agente. Se nenhuma outra mensagem estiver sendo trocada, isso controlará a taxa na qual o cliente enviará mensagens de ping ao agente. Se não for fornecido o valor padrão de 60 segundos, será usado.

auto_connect
bool
Obrigatório

Conecte automaticamente o cliente ao IoTHub quando um método é invocado, o que requer uma conexão a ser estabelecida. (Padrão: True)

connection_retry
bool
Obrigatório

Tentativa de restabelecer uma conexão descartada (Padrão: True)

connection_retry_interval
int
Obrigatório

Intervalo, em segundos, entre tentativas de restabelecer uma conexão descartada (Padrão: 10)

ensure_desired_properties
bool
Obrigatório

Verifique se o patch de propriedades desejadas mais recente foi recebido em novas conexões (Default:True)

Retornos

Uma instância de um cliente IoTHub que usa um certificado X509 para autenticação.

Exceções

TypeError if given an unsupported parameter.

disconnect

Desconecte o cliente do Hub IoT do Azure ou da instância do Hub IoT Edge do Azure.

É recomendável que você certifique-se de chamar essa função quando terminar completamente com a instância do cliente.

Essa é uma chamada síncrona, o que significa que essa função não retornará até que a conexão com o serviço seja completamente fechada.

disconnect()

Exceções

se houver uma falha inesperada durante a execução.

get_twin

Obtém o dispositivo ou o módulo gêmeo do Hub IoT do Azure ou do serviço hub de IoT Edge do Azure.

Essa é uma chamada síncrona, o que significa que essa função não retornará até que o gêmeo seja recuperado do serviço.

get_twin()

Retornos

Concluir gêmeo como um ditado JSON

Tipo de retorno

Exceções

se as credenciais forem inválidas e uma conexão não puder ser estabelecida.

se um estabelecimento de uma conexão resultar em falha.

se a conexão for perdida durante a execução.

se a tentativa de conexão atingir o tempo limite

se o cliente não estiver conectado (e não houver nenhuma conexão automática habilitada)

se houver uma falha inesperada durante a execução.

invoke_method

Invoque um método do cliente em um cliente de dispositivo ou módulo e receba a resposta para a chamada de método.

invoke_method(method_params, device_id, module_id=None)

Parâmetros

method_params
dict
Obrigatório

Deve conter um methodName (str), payload (str), connectTimeoutInSeconds (int), responseTimeoutInSeconds (int).

device_id
str
Obrigatório

ID do dispositivo de destino em que o método será invocado.

module_id
str
valor padrão: None

ID do módulo de destino em que o método será invocado. (Opcional)

Retornos

method_result deve conter um status e um conteúdo

Tipo de retorno

Exceções

se as credenciais forem inválidas e uma conexão não puder ser estabelecida.

se um estabelecimento de uma conexão resultar em falha.

se a conexão for perdida durante a execução.

se a conexão atingir o tempo limite.

se houver uma falha inesperada durante a execução.

patch_twin_reported_properties

Atualize as propriedades relatadas com o serviço Hub IoT do Azure ou Hub IoT Edge do Azure.

Essa é uma chamada síncrona, o que significa que essa função não retornará até que o patch seja enviado para o serviço e reconhecido.

Se o serviço retornar um erro na operação de patch, essa função gerará o erro apropriado.

patch_twin_reported_properties(reported_properties_patch)

Parâmetros

reported_properties_patch
dict
Obrigatório

Patch propriedades relatadas de gêmeo como um ditado JSON

Exceções

se as credenciais forem inválidas e uma conexão não puder ser estabelecida.

se um estabelecimento de uma conexão resultar em falha.

se a conexão for perdida durante a execução.

se a tentativa de conexão atingir o tempo limite

se o cliente não estiver conectado (e não houver nenhuma conexão automática habilitada)

se houver uma falha inesperada durante a execução.

receive_message_on_input

Receba uma mensagem de entrada que foi enviada de outro Módulo para uma entrada específica.

Preterido desde a versão 2.3.0: recomendamos que você use a propriedade .on_message_received para definir um manipulador

receive_message_on_input(input_name, block=True, timeout=None)

Parâmetros

input_name
str
Obrigatório

O nome de entrada no qual receber uma mensagem.

block
bool
Obrigatório

Indica se a operação deve ser bloqueada até que uma mensagem seja recebida.

timeout
int
Obrigatório

Opcionalmente, forneça um número de segundos até o tempo limite de bloqueio.

Retornos

Mensagem que foi enviada para a entrada especificada ou Nenhum se nenhuma solicitação de método tiver sido recebida até o final do período de bloqueio.

Exceções

se as credenciais forem inválidas e uma conexão não puder ser estabelecida.

se um estabelecimento de uma conexão resultar em falha.

se a conexão for perdida durante a execução.

se a conexão atingir o tempo limite.

se houver uma falha inesperada durante a execução.

receive_method_request

Receba uma solicitação de método por meio do Hub IoT do Azure ou do Hub IoT Edge do Azure.

Preterido desde a versão 2.3.0: recomendamos que você use a propriedade .on_method_request_received para definir um manipulador

receive_method_request(method_name=None, block=True, timeout=None)

Parâmetros

method_name
str
valor padrão: None

Opcionalmente, forneça o nome do método para o qual receber solicitações. Se esse parâmetro não for dado, todos os métodos que ainda não estão sendo especificamente direcionados por uma solicitação diferente para receive_method serão recebidos.

block
bool
valor padrão: True

Indica se a operação deve ser bloqueada até que uma solicitação seja recebida.

timeout
int
valor padrão: None

Opcionalmente, forneça um número de segundos até o tempo limite de bloqueio.

Retornos

Objeto MethodRequest que representa a solicitação de método recebido ou Nenhum se nenhuma solicitação de método tiver sido recebida até o final do período de bloqueio.

Exceções

se as credenciais forem inválidas e uma conexão não puder ser estabelecida.

se um estabelecimento de uma conexão resultar em falha.

se a conexão for perdida durante a execução.

se a conexão atingir o tempo limite.

se houver uma falha inesperada durante a execução.

receive_twin_desired_properties_patch

Receba um patch de propriedade desejado por meio do Hub IoT do Azure ou hub de IoT Edge do Azure.

Essa é uma chamada síncrona, o que significa o seguinte:

  1. Se block=True, essa função será bloqueada até que ocorra um destes procedimentos:

    • um patch de propriedade desejado é recebido do Hub IoT do Azure ou do Hub IoT Edge do Azure.

    • o período de tempo limite, se fornecido, decorrido. Se um tempo limite acontecer, essa função gerará uma exceção InboxEmpty

  2. Se block=False, essa função retornará todos os patches de propriedade desejados que possam ter sido recebidos pelo pipeline, mas ainda não retornados ao aplicativo. Se nenhum patche de propriedade desejado tiver sido recebido pelo pipeline, essa função gerará uma exceção InboxEmpty

Preterido desde a versão 2.3.0: recomendamos que você use a propriedade .on_twin_desired_properties_patch_received para definir um manipulador

receive_twin_desired_properties_patch(block=True, timeout=None)

Parâmetros

block
bool
valor padrão: True

Indica se a operação deve ser bloqueada até que uma solicitação seja recebida.

timeout
int
valor padrão: None

Opcionalmente, forneça um número de segundos até o tempo limite de bloqueio.

Retornos

Patch propriedades desejadas de gêmeo como um ditado JSON ou Nenhum se nenhum patch tiver sido recebido até o final do período de bloqueio

Tipo de retorno

dict,

Exceções

se as credenciais forem inválidas e uma conexão não puder ser estabelecida.

se um estabelecimento de uma conexão resultar em falha.

se a conexão for perdida durante a execução.

se a conexão atingir o tempo limite.

se houver uma falha inesperada durante a execução.

send_message

Envia uma mensagem para o ponto de extremidade de eventos padrão no Hub IoT do Azure ou na instância do Hub IoT Edge do Azure.

Esse é um evento síncrono, o que significa que essa função não retornará até que o evento tenha sido enviado ao serviço e o serviço tenha reconhecido o recebimento do evento.

Se a conexão com o serviço não tiver sido aberta anteriormente por uma chamada para se conectar, essa função abrirá a conexão antes de enviar o evento.

send_message(message)

Parâmetros

message
Message
Obrigatório

A mensagem real a ser enviada. Qualquer coisa passada que não seja uma instância da classe Message será convertida em objeto Message.

Exceções

se as credenciais forem inválidas e uma conexão não puder ser estabelecida.

se um estabelecimento de uma conexão resultar em falha.

se a conexão for perdida durante a execução.

se a tentativa de conexão atingir o tempo limite

se o cliente não estiver conectado (e não houver nenhuma conexão automática habilitada)

se houver uma falha inesperada durante a execução.

ValueError if the message fails size validation.

send_message_to_output

Envia um evento/mensagem para a saída do módulo fornecida.

Esses são eventos de saída e devem ser "eventos de saída".

Esse é um evento síncrono, o que significa que essa função não retornará até que o evento tenha sido enviado ao serviço e o serviço tenha reconhecido o recebimento do evento.

Se a conexão com o serviço não tiver sido aberta anteriormente por uma chamada para se conectar, essa função abrirá a conexão antes de enviar o evento.

send_message_to_output(message, output_name)

Parâmetros

message
Message
Obrigatório

Mensagem a ser enviada para a saída fornecida. Qualquer coisa passada que não seja uma instância da classe Message será convertida em objeto Message.

output_name
str
Obrigatório

Nome da saída para a qual enviar o evento.

Exceções

se as credenciais forem inválidas e uma conexão não puder ser estabelecida.

se um estabelecimento de uma conexão resultar em falha.

se a conexão for perdida durante a execução.

se a tentativa de conexão atingir o tempo limite

se o cliente não estiver conectado (e não houver nenhuma conexão automática habilitada)

se houver uma falha inesperada durante a execução.

ValueError if the message fails size validation.

send_method_response

Envie uma resposta a uma solicitação de método por meio do hub Hub IoT do Azure ou do Azure IoT Edge.

Esse é um evento síncrono, o que significa que essa função não retornará até que o evento tenha sido enviado ao serviço e o serviço tenha reconhecido o recebimento do evento.

Se a conexão com o serviço não tiver sido aberta anteriormente por uma chamada para se conectar, essa função abrirá a conexão antes de enviar o evento.

send_method_response(method_response)

Parâmetros

method_response
MethodResponse
Obrigatório

O MethodResponse a ser enviado.

Exceções

se as credenciais forem inválidas e uma conexão não puder ser estabelecida.

se um estabelecimento de uma conexão resultar em falha.

se a conexão for perdida durante a execução.

se a tentativa de conexão atingir o tempo limite

se o cliente não estiver conectado (e não houver nenhuma conexão automática habilitada)

se houver uma falha inesperada durante a execução.

shutdown

Desligue o cliente para uma saída normal.

Depois que esse método for chamado, todas as tentativas em outras chamadas de cliente resultarão na geração de um ClientError

shutdown()

Exceções

se houver uma falha inesperada durante a execução.

update_sastoken

Atualize o Token SAS do cliente usado para autenticação e, em seguida, reautorize a conexão.

Essa API só poderá ser usada se o cliente tiver sido criado inicialmente com um token SAS.

update_sastoken(sastoken)

Parâmetros

sastoken
str
Obrigatório

A nova cadeia de caracteres de Token SAS para o cliente usar

Exceções

ValueError if the sastoken parameter is invalid

se as credenciais forem inválidas e uma conexão não puder ser restabelecida.

se um restabelecimento da conexão resultar em falha.

se a conexão for perdida durante a execução.

se a tentativa de reautorização atingir o tempo limite.

se o cliente não foi criado inicialmente com um token SAS.

se houver uma falha inesperada durante a execução.

Atributos

connected

Propriedade somente leitura para indicar se o transporte está conectado ou não.

on_background_exception

A função de manipulador ou a corrotina serão chamadas quando ocorrer uma exceção em segundo plano.

A função ou definição de corrotina deve ter um argumento posicional (o objeto de exceção)

on_connection_state_change

A função de manipulador ou a corrotina que será chamada quando o estado da conexão for alterado.

A função ou a definição de corrotina não devem ter argumentos posicionais.

on_message_received

A função de manipulador ou a corrotina que será chamada quando uma mensagem de entrada for recebida.

A definição de função ou a corrotina devem ter um argumento posicional (o Message objeto)

on_method_request_received

A função de manipulador ou a corrotina que será chamada quando uma solicitação de método for recebida.

Lembre-se de reconhecer a solicitação de método em sua função ou corrotina por meio do uso do método .send_method_response() do cliente.

A função ou definição de corrotina deve ter um argumento posicional (o MethodRequest objeto)

on_new_sastoken_required

A função de manipulador ou a corrotina que será chamada quando o cliente exigir um novo token SAS. Isso acontecerá aproximadamente 2 minutos antes do token SAS expirar. Em plataformas Windows, se o tempo de vida exceder aproximadamente 49 dias, um novo token será necessário após esses 49 dias, independentemente de quanto tempo o tempo de vida da SAS é.

Observe que esse manipulador só é necessário ao usar um cliente criado por meio do método .create_from_sastoken().

O novo token pode ser fornecido em sua função ou corrotina por meio do uso do método .update_sastoken() do cliente.

A função ou a definição de corrotina não devem ter argumentos posicionais.

on_twin_desired_properties_patch_received

A função de manipulador ou a corrotina que será chamada quando um patch de propriedades desejadas de gêmeo for recebido.

A função ou a definição de corrotina devem ter um argumento posicional (o patch gêmeo na forma de um objeto de dicionário JSON)