CloudToDeviceMessagesOperations Classe

Operações CloudToDeviceMessagesOperations.

Herança

builtins.object

CloudToDeviceMessagesOperations

Construtor

CloudToDeviceMessagesOperations(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 de modelo de objeto.

deserializer

Necessário

Um desserializador de modelo de objeto.

Variáveis

api_version

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

Métodos

abandon_feedback_notification	Abandona o bloqueio numa mensagem de feedback da cloud para o dispositivo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging para obter mais informações.
complete_feedback_notification	Conclui a mensagem de feedback da cloud para o dispositivo. Uma mensagem concluída é eliminada da fila de comentários do serviço. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging para obter mais informações.
purge_cloud_to_device_message_queue	Elimina todos os comandos pendentes de um dispositivo no Hub IoT.
receive_feedback_notification	Obtém o feedback das mensagens da cloud para o dispositivo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging para obter mais informações. Esta capacidade só está disponível no escalão standard Hub IoT. Para obter mais informações, veja Escolher o escalão de Hub IoT certo.

abandon_feedback_notification

Abandona o bloqueio numa mensagem de feedback da cloud para o dispositivo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging para obter mais informações.

abandon_feedback_notification(lock_token, custom_headers=None, raw=False, **operation_config)

Parâmetros

lock_token

str

Necessário

O token de bloqueio obtido quando a mensagem da cloud para o dispositivo é recebida.

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta juntamente com a resposta serializada

operation_config

Necessário

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

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

HttpOperationError

complete_feedback_notification

Conclui a mensagem de feedback da cloud para o dispositivo. Uma mensagem concluída é eliminada da fila de comentários do serviço. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging para obter mais informações.

complete_feedback_notification(lock_token, custom_headers=None, raw=False, **operation_config)

Parâmetros

lock_token

str

Necessário

O token de bloqueio obtido quando a mensagem da cloud para o dispositivo é recebida. Isto é utilizado para resolver condições race ao concluir uma mensagem de feedback.

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta juntamente com a resposta serializada

operation_config

Necessário

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

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

HttpOperationError

purge_cloud_to_device_message_queue

Elimina todos os comandos pendentes de um dispositivo no Hub IoT.

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

Parâmetros

id

str

Necessário

O identificador exclusivo 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 juntamente com a resposta serializada

operation_config

Necessário

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

Devoluções

PurgeMessageQueueResult ou ClientRawResponse se raw=true

Tipo de retorno

PurgeMessageQueueResult,

ClientRawResponse

Exceções

HttpOperationError

receive_feedback_notification

Obtém o feedback das mensagens da cloud para o dispositivo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging para obter mais informações. Esta capacidade só está disponível no escalão standard Hub IoT. Para obter mais informações, veja Escolher o escalão de Hub IoT certo.

receive_feedback_notification(custom_headers=None, raw=False, **operation_config)

Parâmetros

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta juntamente com a resposta serializada

operation_config

Necessário

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

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

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