DeviceClient Classe

Definição

Namespace:

Microsoft.Azure.Devices.Client

Assemblies:

Microsoft.Azure.Devices.Client.dll, Microsoft.Azure.Devices.Client.PCL.dll

Pacotes:

Microsoft.Azure.Devices.Client v1.41.2, Microsoft.Azure.Devices.Client.PCL v1.0.16

Contém métodos que um dispositivo pode usar para enviar mensagens e receber do serviço.

public class DeviceClient : IDisposable

type DeviceClient = class
    interface IDisposable

Public Class DeviceClient
Implements IDisposable

Herança

Object

DeviceClient

Campos

DefaultOperationTimeoutInMilliseconds

Tempo limite de operação padrão.

Propriedades

DiagnosticSamplingPercentage	Valor percentual de amostragem de diagnóstico, [0-100]; 0 significa que nenhuma mensagem continuará diagnóstico informações
OperationTimeoutInMilliseconds	Armazena o tempo limite usado nas tentativas de operação. Observe que esse valor é ignorado para operações em que um token de cancelamento é fornecido. Por exemplo, SendEventAsync(Message) usará esse tempo limite, mas SendEventAsync(Message, CancellationToken) não usará. A última operação só será cancelada pelo token de cancelamento fornecido.
ProductInfo	Armazena informações personalizadas do produto que serão acrescentadas à cadeia de caracteres do agente do usuário que é enviada ao Hub IoT.
RetryPolicy	Obsoleto. Armazena a estratégia de repetição usada nas novas tentativas de operação.

Métodos

AbandonAsync(Message)	Coloca uma mensagem recebida de volta na fila do dispositivo.
AbandonAsync(Message, CancellationToken)	Coloca uma mensagem recebida de volta na fila do dispositivo.
AbandonAsync(String)	Coloca uma mensagem recebida de volta na fila do dispositivo.
AbandonAsync(String, CancellationToken)	Coloca uma mensagem recebida de volta na fila do dispositivo.
CloseAsync()	Feche a instância deviceClient.
CloseAsync(CancellationToken)	Feche a instância deviceClient.
CompleteAsync(Message)	Exclui uma mensagem recebida da fila do dispositivo.
CompleteAsync(Message, CancellationToken)	Exclui uma mensagem recebida da fila do dispositivo.
CompleteAsync(String)	Exclui uma mensagem recebida da fila do dispositivo.
CompleteAsync(String, CancellationToken)	Exclui uma mensagem recebida da fila do dispositivo.
CompleteFileUploadAsync(FileUploadCompletionNotification, CancellationToken)	Notifique o Hub IoT de que o upload de arquivo de um dispositivo foi concluído. Consulte esta documentação para obter mais detalhes.
Create(String, IAuthenticationMethod)	Cria um DeviceClient amqp descartável com base nos parâmetros especificados
Create(String, IAuthenticationMethod, ClientOptions)	Cria um DeviceClient descartável com base nos parâmetros especificados, que usa o protocolo de transporte AMQP.
Create(String, IAuthenticationMethod, ITransportSettings[], ClientOptions)	Cria um DeviceClient descartável com base nos parâmetros especificados
Create(String, IAuthenticationMethod, TransportType)	Cria um DeviceClient descartável com base nos parâmetros especificados
Create(String, IAuthenticationMethod, TransportType, ClientOptions)	Cria um DeviceClient descartável com base nos parâmetros especificados
Create(String, String, IAuthenticationMethod, ClientOptions)	Criar um DeviceClient AMQP descartável com base nos parâmetros especificados
Create(String, String, IAuthenticationMethod, ITransportSettings[], ClientOptions)	Cria um DeviceClient descartável com base nos parâmetros especificados
Create(String, String, IAuthenticationMethod, TransportType, ClientOptions)	Criar um DeviceClient descartável com base nos parâmetros especificados
CreateFromConnectionString(String)	Cria um DeviceClient descartável usando o transporte Amqp da cadeia de conexão especificada
CreateFromConnectionString(String, ClientOptions)	Cria um DeviceClient descartável usando o transporte AMQP da cadeia de conexão especificada
CreateFromConnectionString(String, ITransportSettings[], ClientOptions)	Criar um DeviceClient descartável da cadeia de conexão especificada usando uma lista priorizada de transportes
CreateFromConnectionString(String, String)	Cria um DeviceClient descartável usando o transporte Amqp da cadeia de conexão especificada
CreateFromConnectionString(String, String, ClientOptions)	Cria um DeviceClient descartável usando o transporte AMQP da cadeia de conexão especificada
CreateFromConnectionString(String, String, ITransportSettings[], ClientOptions)	Cria um DeviceClient descartável da cadeia de conexão especificada usando a lista priorizada de transportes
CreateFromConnectionString(String, String, TransportType)	Cria um DeviceClient descartável da cadeia de conexão especificada usando o tipo de transporte especificado
CreateFromConnectionString(String, String, TransportType, ClientOptions)	Cria um DeviceClient descartável da cadeia de conexão especificada usando o tipo de transporte especificado
CreateFromConnectionString(String, TransportType)	Cria um DeviceClient descartável da cadeia de conexão especificada usando o tipo de transporte especificado
CreateFromConnectionString(String, TransportType, ClientOptions)	Cria um DeviceClient descartável da cadeia de conexão especificada usando o tipo de transporte especificado
Dispose()	Libera os recursos não gerenciados usados pelo DeviceClient e, opcionalmente, descarta os recursos gerenciados.
Dispose(Boolean)	Libera os recursos não gerenciados usados pelo DeviceClient e permite que qualquer classe derivada substitua e forneça implementação personalizada.
GetFileUploadSasUriAsync(FileUploadSasUriRequest, CancellationToken)	Obter um URI sas de upload de arquivo que o SDK de Armazenamento do Azure pode usar para carregar um arquivo no blob para este dispositivo Consulte esta documentação para obter mais detalhes.
GetTwinAsync()	Recupere as propriedades do dispositivo gêmeo para o dispositivo atual. Para o objeto de dispositivo gêmeo completo, use Microsoft.Azure.Devices.RegistryManager.GetTwinAsync(string deviceId).
GetTwinAsync(CancellationToken)	Recupere as propriedades do dispositivo gêmeo para o dispositivo atual. Para o objeto de dispositivo gêmeo completo, use Microsoft.Azure.Devices.RegistryManager.GetTwinAsync(string deviceId).
OpenAsync()	Abra explicitamente a instância deviceClient.
OpenAsync(CancellationToken)	Abra explicitamente a instância deviceClient.
ReceiveAsync()	Receba uma mensagem da fila do dispositivo usando o tempo limite padrão. Depois de lidar com uma mensagem recebida, um cliente deve chamar CompleteAsync(Message), AbandonAsync(Message)ou RejectAsync(Message)e, em seguida, descartar a mensagem.
ReceiveAsync(CancellationToken)	Receba uma mensagem da fila do dispositivo usando o token de cancelamento. Depois de lidar com uma mensagem recebida, um cliente deve chamar CompleteAsync(Message, CancellationToken), AbandonAsync(Message, CancellationToken)ou RejectAsync(Message, CancellationToken)e, em seguida, descartar a mensagem.
ReceiveAsync(TimeSpan)	Receba uma mensagem da fila do dispositivo usando um tempo limite. Depois de lidar com uma mensagem recebida, um cliente deve chamar CompleteAsync(Message, CancellationToken), AbandonAsync(Message, CancellationToken)ou RejectAsync(Message, CancellationToken)e, em seguida, descartar a mensagem.
RejectAsync(Message)	Exclui uma mensagem recebida da fila do dispositivo e indica ao servidor que a mensagem não pôde ser processada.
RejectAsync(Message, CancellationToken)	Exclui uma mensagem recebida da fila do dispositivo e indica ao servidor que a mensagem não pôde ser processada.
RejectAsync(String)	Exclui uma mensagem recebida da fila do dispositivo e indica ao servidor que a mensagem não pôde ser processada.
RejectAsync(String, CancellationToken)	Exclui uma mensagem recebida da fila do dispositivo e indica ao servidor que a mensagem não pôde ser processada.
SendEventAsync(Message)	Envia um evento para um hub
SendEventAsync(Message, CancellationToken)	Envia um evento para um hub
SendEventBatchAsync(IEnumerable<Message>)	Envia um lote de eventos para o Hub IoT. Use AMQP ou HTTPs para uma operação de lote verdadeira. O MQTT enviará apenas as mensagens uma após a outra.
SendEventBatchAsync(IEnumerable<Message>, CancellationToken)	Envia um lote de eventos para o Hub IoT. Use AMQP ou HTTPs para uma operação de lote verdadeira. O MQTT enviará apenas as mensagens uma após a outra.
SetConnectionStatusChangesHandler(ConnectionStatusChangesHandler)	Define um novo delegado para a conexão status retorno de chamada alterado. Se um delegado já estiver associado, ele será substituído pelo novo delegado. Observe que esse retorno de chamada nunca será chamado se o cliente estiver configurado para usar HTTP, pois esse protocolo é sem estado.
SetDesiredPropertyUpdateCallback(DesiredPropertyUpdateCallback, Object)	Obsoleto. Defina um retorno de chamada que será chamado sempre que o cliente receber uma atualização de estado (desejada ou relatada) do serviço. Isso tem o efeito colateral de assinar o tópico PATCH no serviço.
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object)	Defina um retorno de chamada que será chamado sempre que o cliente receber uma atualização de estado (desejada ou relatada) do serviço. Defina o valor de retorno de chamada como nulo para limpar.
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object, CancellationToken)	Defina um retorno de chamada que será chamado sempre que o cliente receber uma atualização de estado (desejada ou relatada) do serviço. Defina o valor de retorno de chamada como nulo para limpar.
SetMethodDefaultHandlerAsync(MethodCallback, Object)	Define um novo delegado que é chamado para um método que não tem um delegado registrado para seu nome. Se um delegado padrão já estiver registrado, ele substituirá pelo novo delegado. Um manipulador de método pode ser desconjunto passando um MethodCallback nulo.
SetMethodDefaultHandlerAsync(MethodCallback, Object, CancellationToken)	Define um novo delegado que é chamado para um método que não tem um delegado registrado para seu nome. Se um delegado padrão já estiver registrado, ele substituirá pelo novo delegado. Um manipulador de método pode ser desconjunto passando um MethodCallback nulo.
SetMethodHandler(String, MethodCallback, Object)	Obsoleto. Define um novo delegado para o método nomeado. Se um delegado já estiver associado ao método nomeado, ele será substituído pelo novo delegado.
SetMethodHandlerAsync(String, MethodCallback, Object)	Define um novo delegado para o método nomeado. Se um delegado já estiver associado ao método nomeado, ele será substituído pelo novo delegado. Um manipulador de método pode ser desconjunto passando um MethodCallback nulo.
SetMethodHandlerAsync(String, MethodCallback, Object, CancellationToken)	Define um novo delegado para o método nomeado. Se um delegado já estiver associado ao método nomeado, ele será substituído pelo novo delegado. Um manipulador de método pode ser desconjunto passando um MethodCallback nulo.
SetReceiveMessageHandlerAsync(ReceiveMessageCallback, Object, CancellationToken)	Define um novo delegado para receber uma mensagem da fila do dispositivo usando um token de cancelamento. Depois de lidar com uma mensagem recebida, um cliente deve chamar CompleteAsync(Message, CancellationToken), AbandonAsync(Message, CancellationToken)ou RejectAsync(Message, CancellationToken)e, em seguida, descartar a mensagem. Se um delegado nulo for passado, ele desabilitará o retorno de chamada disparado ao receber mensagens do serviço.
SetRetryPolicy(IRetryPolicy)	Define a política de repetição usada nas tentativas de operação. A alteração entrará em vigor após qualquer operação em andamento.
UpdateReportedPropertiesAsync(TwinCollection)	Efetuar push das alterações de propriedade relatadas para o serviço.
UpdateReportedPropertiesAsync(TwinCollection, CancellationToken)	Efetuar push das alterações de propriedade relatadas para o serviço.
UploadToBlobAsync(String, Stream)	Obsoleto. Carrega um fluxo para um blob de blocos em uma conta de armazenamento associada ao IoTHub para esse dispositivo. Se o blob já existir, ele será substituído.
UploadToBlobAsync(String, Stream, CancellationToken)	Obsoleto. Carrega um fluxo para um blob de blocos em uma conta de armazenamento associada ao IoTHub para esse dispositivo. Se o blob já existir, ele será substituído.