DeviceClient Classe

Définition

Espace de noms:

Microsoft.Azure.Devices.Client

Assemblys:

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

Paquets:

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

Contient des méthodes qu’un appareil peut utiliser pour envoyer des messages à et recevoir à partir du service.

public class DeviceClient : IDisposable

type DeviceClient = class
    interface IDisposable

Public Class DeviceClient
Implements IDisposable

Héritage

Object

DeviceClient

Champs

DefaultOperationTimeoutInMilliseconds

Délai d’expiration de l’opération par défaut.

Propriétés

DiagnosticSamplingPercentage	Valeur du pourcentage d’échantillonnage de diagnostic, [0-100]; 0 signifie qu’aucun message ne sera conservé diagnostics informations
OperationTimeoutInMilliseconds	Stocke le délai d’expiration utilisé dans les nouvelles tentatives d’opération. Notez que cette valeur est ignorée pour les opérations où un jeton d’annulation est fourni. Par exemple, SendEventAsync(Message) utilise ce délai d’expiration, mais SendEventAsync(Message, CancellationToken) pas. Cette dernière opération est uniquement annulée par le jeton d’annulation fourni.
ProductInfo	Stocke des informations de produit personnalisées qui seront ajoutées à la chaîne d’agent utilisateur envoyée à IoT Hub.
RetryPolicy	Obsolète. Stocke la stratégie de nouvelle tentative utilisée dans les nouvelles tentatives d’opération.

Méthodes

AbandonAsync(Message)	Replace un message reçu dans la file d’attente de l’appareil.
AbandonAsync(Message, CancellationToken)	Replace un message reçu dans la file d’attente de l’appareil.
AbandonAsync(String)	Replace un message reçu dans la file d’attente de l’appareil.
AbandonAsync(String, CancellationToken)	Replace un message reçu dans la file d’attente de l’appareil.
CloseAsync()	Fermez le instance DeviceClient.
CloseAsync(CancellationToken)	Fermez le instance DeviceClient.
CompleteAsync(Message)	Supprime un message reçu de la file d’attente de l’appareil.
CompleteAsync(Message, CancellationToken)	Supprime un message reçu de la file d’attente de l’appareil.
CompleteAsync(String)	Supprime un message reçu de la file d’attente de l’appareil.
CompleteAsync(String, CancellationToken)	Supprime un message reçu de la file d’attente de l’appareil.
CompleteFileUploadAsync(FileUploadCompletionNotification, CancellationToken)	Informez IoT Hub que le chargement de fichiers d’un appareil est terminé. Pour plus d’informations, consultez cette documentation.
Create(String, IAuthenticationMethod)	Crée un appareil Amqp DeviceClient jetable à partir des paramètres spécifiés
Create(String, IAuthenticationMethod, ClientOptions)	Crée un DeviceClient jetable à partir des paramètres spécifiés, qui utilise le protocole de transport AMQP.
Create(String, IAuthenticationMethod, ITransportSettings[], ClientOptions)	Crée un DeviceClient jetable à partir des paramètres spécifiés
Create(String, IAuthenticationMethod, TransportType)	Crée un DeviceClient jetable à partir des paramètres spécifiés
Create(String, IAuthenticationMethod, TransportType, ClientOptions)	Crée un DeviceClient jetable à partir des paramètres spécifiés
Create(String, String, IAuthenticationMethod, ClientOptions)	Créer un appareil AMQP DeviceClient jetable à partir des paramètres spécifiés
Create(String, String, IAuthenticationMethod, ITransportSettings[], ClientOptions)	Crée un DeviceClient jetable à partir des paramètres spécifiés
Create(String, String, IAuthenticationMethod, TransportType, ClientOptions)	Créer un DeviceClient jetable à partir des paramètres spécifiés
CreateFromConnectionString(String)	Crée un DeviceClient jetable à l’aide du transport Amqp à partir de la chaîne de connexion spécifiée
CreateFromConnectionString(String, ClientOptions)	Crée un DeviceClient jetable à l’aide du transport AMQP à partir de la chaîne de connexion spécifiée
CreateFromConnectionString(String, ITransportSettings[], ClientOptions)	Créer un DeviceClient jetable à partir de la chaîne de connexion spécifiée à l’aide d’une liste hiérarchisée de transports
CreateFromConnectionString(String, String)	Crée un DeviceClient jetable à l’aide du transport Amqp à partir de la chaîne de connexion spécifiée
CreateFromConnectionString(String, String, ClientOptions)	Crée un DeviceClient jetable à l’aide du transport AMQP à partir de la chaîne de connexion spécifiée
CreateFromConnectionString(String, String, ITransportSettings[], ClientOptions)	Crée un DeviceClient jetable à partir de la chaîne de connexion spécifiée à l’aide de la liste hiérarchisée des transports
CreateFromConnectionString(String, String, TransportType)	Crée un DeviceClient jetable à partir de la chaîne de connexion spécifiée à l’aide du type de transport spécifié
CreateFromConnectionString(String, String, TransportType, ClientOptions)	Crée un DeviceClient jetable à partir de la chaîne de connexion spécifiée à l’aide du type de transport spécifié
CreateFromConnectionString(String, TransportType)	Crée un DeviceClient jetable à partir de la chaîne de connexion spécifiée à l’aide du type de transport spécifié
CreateFromConnectionString(String, TransportType, ClientOptions)	Crée un DeviceClient jetable à partir de la chaîne de connexion spécifiée à l’aide du type de transport spécifié
Dispose()	Libère les ressources non managées utilisées par DeviceClient et supprime éventuellement les ressources managées.
Dispose(Boolean)	Libère les ressources non managées utilisées par DeviceClient et permet à toute classe dérivée de remplacer et de fournir une implémentation personnalisée.
GetFileUploadSasUriAsync(FileUploadSasUriRequest, CancellationToken)	Obtenir un URI SAS de chargement de fichier que le SDK Stockage Azure peut utiliser pour charger un fichier dans un objet blob pour cet appareil Consultez cette documentation pour plus d’informations.
GetTwinAsync()	Récupérez les propriétés du jumeau d’appareil pour l’appareil actuel. Pour l’objet de jumeau d’appareil complet, utilisez Microsoft.Azure.Devices.RegistryManager.GetTwinAsync(string deviceId).
GetTwinAsync(CancellationToken)	Récupérez les propriétés du jumeau d’appareil pour l’appareil actuel. Pour l’objet de jumeau d’appareil complet, utilisez Microsoft.Azure.Devices.RegistryManager.GetTwinAsync(string deviceId).
OpenAsync()	Ouvrez explicitement le instance DeviceClient.
OpenAsync(CancellationToken)	Ouvrez explicitement le instance DeviceClient.
ReceiveAsync()	Recevez un message de la file d’attente de l’appareil à l’aide du délai d’expiration par défaut. Après avoir géré un message reçu, un client doit appeler CompleteAsync(Message), AbandonAsync(Message)ou RejectAsync(Message), puis supprimer le message.
ReceiveAsync(CancellationToken)	Recevez un message de la file d’attente de l’appareil à l’aide du jeton d’annulation. Après avoir géré un message reçu, un client doit appeler CompleteAsync(Message, CancellationToken), AbandonAsync(Message, CancellationToken)ou RejectAsync(Message, CancellationToken), puis supprimer le message.
ReceiveAsync(TimeSpan)	Recevez un message de la file d’attente de l’appareil à l’aide d’un délai d’expiration. Après avoir géré un message reçu, un client doit appeler CompleteAsync(Message, CancellationToken), AbandonAsync(Message, CancellationToken)ou RejectAsync(Message, CancellationToken), puis supprimer le message.
RejectAsync(Message)	Supprime un message reçu de la file d’attente de l’appareil et indique au serveur que le message n’a pas pu être traité.
RejectAsync(Message, CancellationToken)	Supprime un message reçu de la file d’attente de l’appareil et indique au serveur que le message n’a pas pu être traité.
RejectAsync(String)	Supprime un message reçu de la file d’attente de l’appareil et indique au serveur que le message n’a pas pu être traité.
RejectAsync(String, CancellationToken)	Supprime un message reçu de la file d’attente de l’appareil et indique au serveur que le message n’a pas pu être traité.
SendEventAsync(Message)	Envoie un événement à un hub
SendEventAsync(Message, CancellationToken)	Envoie un événement à un hub
SendEventBatchAsync(IEnumerable<Message>)	Envoie un lot d’événements à IoT Hub. Utilisez AMQP ou HTTPs pour une véritable opération de traitement par lots. MQTT envoie simplement les messages les uns après les autres.
SendEventBatchAsync(IEnumerable<Message>, CancellationToken)	Envoie un lot d’événements à IoT Hub. Utilisez AMQP ou HTTPs pour une véritable opération de traitement par lots. MQTT envoie simplement les messages les uns après les autres.
SetConnectionStatusChangesHandler(ConnectionStatusChangesHandler)	Définit un nouveau délégué pour la connexion status rappel modifié. Si un délégué est déjà associé, il est remplacé par le nouveau délégué. Notez que ce rappel ne sera jamais appelé si le client est configuré pour utiliser HTTP, car ce protocole est sans état.
SetDesiredPropertyUpdateCallback(DesiredPropertyUpdateCallback, Object)	Obsolète. Définissez un rappel qui sera appelé chaque fois que le client reçoit une mise à jour d’état (souhaitée ou signalée) du service. Cela a l’effet secondaire de l’abonnement à la rubrique PATCH sur le service.
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object)	Définissez un rappel qui sera appelé chaque fois que le client reçoit une mise à jour d’état (souhaitée ou signalée) du service. Définissez la valeur de rappel sur null pour effacer.
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object, CancellationToken)	Définissez un rappel qui sera appelé chaque fois que le client reçoit une mise à jour d’état (souhaitée ou signalée) du service. Définissez la valeur de rappel sur null pour effacer.
SetMethodDefaultHandlerAsync(MethodCallback, Object)	Définit un nouveau délégué appelé pour une méthode qui n’a pas de délégué inscrit pour son nom. Si un délégué par défaut est déjà inscrit, il est remplacé par le nouveau délégué. Un gestionnaire de méthode peut être décompressé en passant un MethodCallback null.
SetMethodDefaultHandlerAsync(MethodCallback, Object, CancellationToken)	Définit un nouveau délégué appelé pour une méthode qui n’a pas de délégué inscrit pour son nom. Si un délégué par défaut est déjà inscrit, il est remplacé par le nouveau délégué. Un gestionnaire de méthode peut être décompressé en passant un MethodCallback null.
SetMethodHandler(String, MethodCallback, Object)	Obsolète. Définit un nouveau délégué pour la méthode nommée. Si un délégué est déjà associé à la méthode nommée, il est remplacé par le nouveau délégué.
SetMethodHandlerAsync(String, MethodCallback, Object)	Définit un nouveau délégué pour la méthode nommée. Si un délégué est déjà associé à la méthode nommée, il est remplacé par le nouveau délégué. Un gestionnaire de méthode peut être décompressé en passant un MethodCallback null.
SetMethodHandlerAsync(String, MethodCallback, Object, CancellationToken)	Définit un nouveau délégué pour la méthode nommée. Si un délégué est déjà associé à la méthode nommée, il est remplacé par le nouveau délégué. Un gestionnaire de méthode peut être décompressé en passant un MethodCallback null.
SetReceiveMessageHandlerAsync(ReceiveMessageCallback, Object, CancellationToken)	Définit un nouveau délégué pour la réception d’un message de la file d’attente de l’appareil à l’aide d’un jeton d’annulation. Après avoir géré un message reçu, un client doit appeler CompleteAsync(Message, CancellationToken), AbandonAsync(Message, CancellationToken)ou RejectAsync(Message, CancellationToken), puis supprimer le message. Si un délégué Null est passé, il désactive le rappel déclenché lors de la réception de messages du service.
SetRetryPolicy(IRetryPolicy)	Définit la stratégie de nouvelle tentative utilisée dans les nouvelles tentatives d’opération. La modification prend effet après toutes les opérations en cours.
UpdateReportedPropertiesAsync(TwinCollection)	Envoyez (push) les modifications de propriété signalées au service.
UpdateReportedPropertiesAsync(TwinCollection, CancellationToken)	Envoyez (push) les modifications de propriété signalées au service.
UploadToBlobAsync(String, Stream)	Obsolète. Charge un flux vers un objet blob de blocs dans un compte de stockage associé à l’IoTHub pour cet appareil. Si l’objet blob existe déjà, il est remplacé.
UploadToBlobAsync(String, Stream, CancellationToken)	Obsolète. Charge un flux vers un objet blob de blocs dans un compte de stockage associé à l’IoTHub pour cet appareil. Si l’objet blob existe déjà, il sera remplacé.