DeviceClient Clase

Definición

Espacio de nombres:

Microsoft.Azure.Devices.Client

Ensamblados:

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

Paquetes:

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

Contiene métodos que un dispositivo puede usar para enviar y recibir mensajes desde el servicio.

public class DeviceClient : IDisposable

type DeviceClient = class
    interface IDisposable

Public Class DeviceClient
Implements IDisposable

Herencia

Object

DeviceClient

Campos

DefaultOperationTimeoutInMilliseconds

Tiempo de espera de operación predeterminado.

Propiedades

DiagnosticSamplingPercentage	Valor de porcentaje de muestreo de diagnóstico, [0-100]; 0 significa que ningún mensaje llevará a cabo información de diagnóstico
OperationTimeoutInMilliseconds	Almacena el tiempo de espera usado en los reintentos de la operación. Tenga en cuenta que este valor se omite para las operaciones en las que se proporciona un token de cancelación. Por ejemplo, SendEventAsync(Message) usará este tiempo de espera, pero SendEventAsync(Message, CancellationToken) no lo hará. La última operación solo la cancelará el token de cancelación proporcionado.
ProductInfo	Almacena información de producto personalizada que se anexará a la cadena del agente de usuario que se envía a IoT Hub.
RetryPolicy	Obsoletos. Almacena la estrategia de reintento usada en los reintentos de la operación.

Métodos

AbandonAsync(Message)	Vuelve a colocar un mensaje recibido en la cola del dispositivo.
AbandonAsync(Message, CancellationToken)	Vuelve a colocar un mensaje recibido en la cola del dispositivo.
AbandonAsync(String)	Vuelve a colocar un mensaje recibido en la cola del dispositivo.
AbandonAsync(String, CancellationToken)	Vuelve a colocar un mensaje recibido en la cola del dispositivo.
CloseAsync()	Cierre la instancia de DeviceClient.
CloseAsync(CancellationToken)	Cierre la instancia de DeviceClient.
CompleteAsync(Message)	Elimina un mensaje recibido de la cola de dispositivos.
CompleteAsync(Message, CancellationToken)	Elimina un mensaje recibido de la cola de dispositivos.
CompleteAsync(String)	Elimina un mensaje recibido de la cola de dispositivos.
CompleteAsync(String, CancellationToken)	Elimina un mensaje recibido de la cola de dispositivos.
CompleteFileUploadAsync(FileUploadCompletionNotification, CancellationToken)	Notifique a IoT Hub que ha finalizado la carga de archivos de un dispositivo. Consulte esta documentación para obtener más detalles.
Create(String, IAuthenticationMethod)	Crea un deviceClient descartable a partir de los parámetros especificados.
Create(String, IAuthenticationMethod, ClientOptions)	Crea un DeviceClient descartable a partir de los parámetros especificados, que usa el protocolo de transporte AMQP.
Create(String, IAuthenticationMethod, ITransportSettings[], ClientOptions)	Crea un DeviceClient descartable a partir de los parámetros especificados.
Create(String, IAuthenticationMethod, TransportType)	Crea un DeviceClient descartable a partir de los parámetros especificados.
Create(String, IAuthenticationMethod, TransportType, ClientOptions)	Crea un DeviceClient descartable a partir de los parámetros especificados.
Create(String, String, IAuthenticationMethod, ClientOptions)	Creación de un dispositivo AMQP descartable a partir de los parámetros especificados
Create(String, String, IAuthenticationMethod, ITransportSettings[], ClientOptions)	Crea un DeviceClient descartable a partir de los parámetros especificados.
Create(String, String, IAuthenticationMethod, TransportType, ClientOptions)	Crear un DeviceClient descartable a partir de los parámetros especificados
CreateFromConnectionString(String)	Crea un DeviceClient descartable mediante el transporte amqp a partir de la cadena de conexión especificada.
CreateFromConnectionString(String, ClientOptions)	Crea un DeviceClient descartable mediante el transporte AMQP desde la cadena de conexión especificada.
CreateFromConnectionString(String, ITransportSettings[], ClientOptions)	Creación de un DeviceClient descartable a partir de la cadena de conexión especificada mediante una lista prioritaria de transportes
CreateFromConnectionString(String, String)	Crea un DeviceClient descartable mediante el transporte amqp a partir de la cadena de conexión especificada.
CreateFromConnectionString(String, String, ClientOptions)	Crea un DeviceClient descartable mediante el transporte AMQP desde la cadena de conexión especificada.
CreateFromConnectionString(String, String, ITransportSettings[], ClientOptions)	Crea un DeviceClient descartable a partir de la cadena de conexión especificada mediante la lista prioritaria de transportes.
CreateFromConnectionString(String, String, TransportType)	Crea un DeviceClient descartable a partir de la cadena de conexión especificada mediante el tipo de transporte especificado.
CreateFromConnectionString(String, String, TransportType, ClientOptions)	Crea un DeviceClient descartable a partir de la cadena de conexión especificada mediante el tipo de transporte especificado.
CreateFromConnectionString(String, TransportType)	Crea un DeviceClient descartable a partir de la cadena de conexión especificada mediante el tipo de transporte especificado.
CreateFromConnectionString(String, TransportType, ClientOptions)	Crea un DeviceClient descartable a partir de la cadena de conexión especificada mediante el tipo de transporte especificado.
Dispose()	Libera los recursos no administrados usados por DeviceClient y, opcionalmente, elimina los recursos administrados.
Dispose(Boolean)	Libera los recursos no administrados usados por DeviceClient y permite que cualquier clase derivada invalide y proporcione una implementación personalizada.
GetFileUploadSasUriAsync(FileUploadSasUriRequest, CancellationToken)	Obtenga un URI de SAS de carga de archivos que el SDK de Azure Storage puede usar para cargar un archivo en blob para este dispositivo. Consulte esta documentación para obtener más detalles.
GetTwinAsync()	Recupere las propiedades del dispositivo gemelo para el dispositivo actual. Para el objeto gemelo completo, use Microsoft.Azure.Devices.RegistryManager.GetTwinAsync(string deviceId).
GetTwinAsync(CancellationToken)	Recupere las propiedades del dispositivo gemelo para el dispositivo actual. Para el objeto gemelo completo, use Microsoft.Azure.Devices.RegistryManager.GetTwinAsync(string deviceId).
OpenAsync()	Abra explícitamente la instancia de DeviceClient.
OpenAsync(CancellationToken)	Abra explícitamente la instancia de DeviceClient.
ReceiveAsync()	Reciba un mensaje de la cola de dispositivos con el tiempo de espera predeterminado. Después de controlar un mensaje recibido, un cliente debe llamar a CompleteAsync(Message), AbandonAsync(Message)o RejectAsync(Message)y, a continuación, eliminar el mensaje.
ReceiveAsync(CancellationToken)	Reciba un mensaje de la cola de dispositivos mediante el token de cancelación. Después de controlar un mensaje recibido, un cliente debe llamar a CompleteAsync(Message, CancellationToken), AbandonAsync(Message, CancellationToken)o RejectAsync(Message, CancellationToken)y, a continuación, eliminar el mensaje.
ReceiveAsync(TimeSpan)	Reciba un mensaje de la cola de dispositivos mediante un tiempo de espera. Después de controlar un mensaje recibido, un cliente debe llamar a CompleteAsync(Message, CancellationToken), AbandonAsync(Message, CancellationToken)o RejectAsync(Message, CancellationToken)y, a continuación, eliminar el mensaje.
RejectAsync(Message)	Elimina un mensaje recibido de la cola de dispositivos e indica al servidor que no se pudo procesar el mensaje.
RejectAsync(Message, CancellationToken)	Elimina un mensaje recibido de la cola de dispositivos e indica al servidor que no se pudo procesar el mensaje.
RejectAsync(String)	Elimina un mensaje recibido de la cola de dispositivos e indica al servidor que no se pudo procesar el mensaje.
RejectAsync(String, CancellationToken)	Elimina un mensaje recibido de la cola de dispositivos e indica al servidor que no se pudo procesar el mensaje.
SendEventAsync(Message)	Envía un evento a un centro
SendEventAsync(Message, CancellationToken)	Envía un evento a un centro
SendEventBatchAsync(IEnumerable<Message>)	Envía un lote de eventos a IoT Hub. Use AMQP o HTTP para una operación por lotes verdadera. MQTT solo enviará los mensajes uno después del otro.
SendEventBatchAsync(IEnumerable<Message>, CancellationToken)	Envía un lote de eventos a IoT Hub. Use AMQP o HTTP para una operación por lotes verdadera. MQTT solo enviará los mensajes uno después del otro.
SetConnectionStatusChangesHandler(ConnectionStatusChangesHandler)	Establece un nuevo delegado para la devolución de llamada modificada del estado de conexión. Si un delegado ya está asociado, se reemplazará por el nuevo delegado. Tenga en cuenta que nunca se llamará a esta devolución de llamada si el cliente está configurado para usar HTTP, ya que ese protocolo no tiene estado.
SetDesiredPropertyUpdateCallback(DesiredPropertyUpdateCallback, Object)	Obsoletos. Establezca una devolución de llamada a la que se llamará cada vez que el cliente reciba una actualización de estado (deseada o notificada) del servicio. Esto tiene el efecto secundario de suscribirse al tema PATCH en el servicio.
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object)	Establezca una devolución de llamada a la que se llamará cada vez que el cliente reciba una actualización de estado (deseada o notificada) del servicio. Establezca el valor de devolución de llamada en NULL para borrarlo.
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object, CancellationToken)	Establezca una devolución de llamada a la que se llamará cada vez que el cliente reciba una actualización de estado (deseada o notificada) del servicio. Establezca el valor de devolución de llamada en NULL para borrarlo.
SetMethodDefaultHandlerAsync(MethodCallback, Object)	Establece un nuevo delegado al que se llama para un método que no tiene un delegado registrado para su nombre. Si un delegado predeterminado ya está registrado, reemplazará por el nuevo delegado. Un controlador de métodos se puede anular pasando un MethodCallback nulo.
SetMethodDefaultHandlerAsync(MethodCallback, Object, CancellationToken)	Establece un nuevo delegado al que se llama para un método que no tiene un delegado registrado para su nombre. Si un delegado predeterminado ya está registrado, reemplazará por el nuevo delegado. Un controlador de métodos se puede anular pasando un MethodCallback nulo.
SetMethodHandler(String, MethodCallback, Object)	Obsoletos. Establece un nuevo delegado para el método con nombre. Si un delegado ya está asociado al método con nombre, se reemplazará por el nuevo delegado.
SetMethodHandlerAsync(String, MethodCallback, Object)	Establece un nuevo delegado para el método con nombre. Si un delegado ya está asociado al método con nombre, se reemplazará por el nuevo delegado. Un controlador de métodos se puede anular pasando un MethodCallback nulo.
SetMethodHandlerAsync(String, MethodCallback, Object, CancellationToken)	Establece un nuevo delegado para el método con nombre. Si un delegado ya está asociado al método con nombre, se reemplazará por el nuevo delegado. Un controlador de métodos se puede anular pasando un MethodCallback nulo.
SetReceiveMessageHandlerAsync(ReceiveMessageCallback, Object, CancellationToken)	Establece un nuevo delegado para recibir un mensaje de la cola de dispositivos mediante un token de cancelación. Después de controlar un mensaje recibido, un cliente debe llamar a CompleteAsync(Message, CancellationToken), AbandonAsync(Message, CancellationToken)o RejectAsync(Message, CancellationToken)y, a continuación, eliminar el mensaje. Si se pasa un delegado NULL, deshabilitará la devolución de llamada desencadenada al recibir mensajes del servicio.
SetRetryPolicy(IRetryPolicy)	Establece la directiva de reintentos usada en los reintentos de la operación. El cambio surtirá efecto después de las operaciones en curso.
UpdateReportedPropertiesAsync(TwinCollection)	Inserte los cambios de propiedad notificados hasta el servicio.
UpdateReportedPropertiesAsync(TwinCollection, CancellationToken)	Inserte los cambios de propiedad notificados hasta el servicio.
UploadToBlobAsync(String, Stream)	Obsoletos. Carga una secuencia en un blob en bloques en una cuenta de almacenamiento asociada a IoTHub para ese dispositivo. Si el blob ya existe, se sobrescribirá.
UploadToBlobAsync(String, Stream, CancellationToken)	Obsoletos. Carga una secuencia en un blob en bloques en una cuenta de almacenamiento asociada a IoTHub para ese dispositivo. Si el blob ya existe, se sobrescribirá.