DeviceClient Klasse

Definition

Namespace:

Microsoft.Azure.Devices.Client

Assemblys:

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

Pakete:

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

Enthält Methoden, die ein Gerät zum Senden und Empfangen von Nachrichten an den Dienst verwenden kann.

public class DeviceClient : IDisposable

type DeviceClient = class
    interface IDisposable

Public Class DeviceClient
Implements IDisposable

Vererbung

Object

DeviceClient

Felder

DefaultOperationTimeoutInMilliseconds

Timeout des Standardvorgangs.

Eigenschaften

DiagnosticSamplingPercentage	Prozentsatzwert für die Diagnostische Stichprobenentnahme[ 0-100]; 0 bedeutet, dass keine Nachricht Diagnose Informationen gesendet wird.
OperationTimeoutInMilliseconds	Speichert das Timeout, das in den Vorgangsversuchen verwendet wird. Beachten Sie, dass dieser Wert für Vorgänge ignoriert wird, bei denen ein Abbruchtoken bereitgestellt wird. Verwendet z. B SendEventAsync(Message) . dieses Timeout, aber SendEventAsync(Message, CancellationToken) nicht. Der letztere Vorgang wird nur durch das bereitgestellte Abbruchtoken abgebrochen.
ProductInfo	Speichert benutzerdefinierte Produktinformationen, die an die Benutzer-Agent-Zeichenfolge angefügt werden, die an IoT Hub gesendet wird.
RetryPolicy	Veraltet. Speichert die Wiederholungsstrategie, die in den Wiederholungsversuchen des Vorgangs verwendet wird.

Methoden

AbandonAsync(Message)	Fügt eine empfangene Nachricht wieder in die Gerätewarteschlange ein.
AbandonAsync(Message, CancellationToken)	Fügt eine empfangene Nachricht wieder in die Gerätewarteschlange ein.
AbandonAsync(String)	Fügt eine empfangene Nachricht wieder in die Gerätewarteschlange ein.
AbandonAsync(String, CancellationToken)	Fügt eine empfangene Nachricht wieder in die Gerätewarteschlange ein.
CloseAsync()	Schließen Sie die DeviceClient-instance.
CloseAsync(CancellationToken)	Schließen Sie die DeviceClient-instance.
CompleteAsync(Message)	Löscht eine empfangene Nachricht aus der Gerätewarteschlange.
CompleteAsync(Message, CancellationToken)	Löscht eine empfangene Nachricht aus der Gerätewarteschlange.
CompleteAsync(String)	Löscht eine empfangene Nachricht aus der Gerätewarteschlange.
CompleteAsync(String, CancellationToken)	Löscht eine empfangene Nachricht aus der Gerätewarteschlange.
CompleteFileUploadAsync(FileUploadCompletionNotification, CancellationToken)	Benachrichtigen Sie IoT Hub, dass der Dateiupload eines Geräts abgeschlossen ist. Weitere Informationen finden Sie in dieser Dokumentation.
Create(String, IAuthenticationMethod)	Erstellt einen verwerfbaren Amqp DeviceClient aus den angegebenen Parametern.
Create(String, IAuthenticationMethod, ClientOptions)	Erstellt einen verwerfbaren DeviceClient aus den angegebenen Parametern, der das AMQP-Transportprotokoll verwendet.
Create(String, IAuthenticationMethod, ITransportSettings[], ClientOptions)	Erstellt einen verwerfbaren DeviceClient aus den angegebenen Parametern.
Create(String, IAuthenticationMethod, TransportType)	Erstellt einen verwerfbaren DeviceClient aus den angegebenen Parametern.
Create(String, IAuthenticationMethod, TransportType, ClientOptions)	Erstellt einen verwerfbaren DeviceClient aus den angegebenen Parametern.
Create(String, String, IAuthenticationMethod, ClientOptions)	Erstellen eines verwerfbaren AMQP DeviceClient aus den angegebenen Parametern
Create(String, String, IAuthenticationMethod, ITransportSettings[], ClientOptions)	Erstellt einen verwerfbaren DeviceClient aus den angegebenen Parametern.
Create(String, String, IAuthenticationMethod, TransportType, ClientOptions)	Erstellen eines verwerfbaren DeviceClient aus den angegebenen Parametern
CreateFromConnectionString(String)	Erstellt einen verwerfbaren DeviceClient mithilfe des Amqp-Transports aus der angegebenen Verbindungszeichenfolge.
CreateFromConnectionString(String, ClientOptions)	Erstellt einen verwerfbaren DeviceClient mithilfe des AMQP-Transports aus der angegebenen Verbindungszeichenfolge.
CreateFromConnectionString(String, ITransportSettings[], ClientOptions)	Erstellen eines verwerfbaren DeviceClient aus der angegebenen Verbindungszeichenfolge mithilfe einer priorisierten Liste von Transporten
CreateFromConnectionString(String, String)	Erstellt einen verwerfbaren DeviceClient mithilfe des Amqp-Transports aus der angegebenen Verbindungszeichenfolge.
CreateFromConnectionString(String, String, ClientOptions)	Erstellt einen verwerfbaren DeviceClient mithilfe des AMQP-Transports aus der angegebenen Verbindungszeichenfolge.
CreateFromConnectionString(String, String, ITransportSettings[], ClientOptions)	Erstellt mithilfe der priorisierten Liste der Transporte einen verwerfbaren DeviceClient aus der angegebenen Verbindungszeichenfolge.
CreateFromConnectionString(String, String, TransportType)	Erstellt einen verwerfbaren DeviceClient aus der angegebenen Verbindungszeichenfolge unter Verwendung des angegebenen Transporttyps.
CreateFromConnectionString(String, String, TransportType, ClientOptions)	Erstellt einen verwerfbaren DeviceClient aus der angegebenen Verbindungszeichenfolge unter Verwendung des angegebenen Transporttyps.
CreateFromConnectionString(String, TransportType)	Erstellt einen verwerfbaren DeviceClient aus der angegebenen Verbindungszeichenfolge unter Verwendung des angegebenen Transporttyps.
CreateFromConnectionString(String, TransportType, ClientOptions)	Erstellt einen verwerfbaren DeviceClient aus der angegebenen Verbindungszeichenfolge unter Verwendung des angegebenen Transporttyps.
Dispose()	Gibt die nicht verwalteten Ressourcen frei, die vom DeviceClient verwendet werden, und entsorgt optional die verwalteten Ressourcen.
Dispose(Boolean)	Gibt die nicht verwalteten Ressourcen frei, die vom DeviceClient verwendet werden, und ermöglicht es jeder abgeleiteten Klasse, eine benutzerdefinierte Implementierung zu überschreiben und bereitzustellen.
GetFileUploadSasUriAsync(FileUploadSasUriRequest, CancellationToken)	Abrufen eines SAS-URI für den Dateiupload, den das Azure Storage SDK zum Hochladen einer Datei in ein Blob für dieses Gerät verwenden kann Weitere Informationen finden Sie in dieser Dokumentation.
GetTwinAsync()	Rufen Sie die Gerätezwilligeneigenschaften für das aktuelle Gerät ab. Verwenden Sie für das vollständige Gerätezwillingsobjekt Microsoft.Azure.Devices.RegistryManager.GetTwinAsync(string deviceId).
GetTwinAsync(CancellationToken)	Rufen Sie die Gerätezwilligeneigenschaften für das aktuelle Gerät ab. Verwenden Sie für das vollständige Gerätezwillingsobjekt Microsoft.Azure.Devices.RegistryManager.GetTwinAsync(string deviceId).
OpenAsync()	Öffnen Sie die DeviceClient-instance explizit.
OpenAsync(CancellationToken)	Öffnen Sie die DeviceClient-instance explizit.
ReceiveAsync()	Empfangen einer Nachricht aus der Gerätewarteschlange mithilfe des Standardtimeouts. Nach der Behandlung einer empfangenen Nachricht sollte ein Client , AbandonAsync(Message)oder RejectAsync(Message)aufrufen CompleteAsync(Message)und die Nachricht dann verwerfen.
ReceiveAsync(CancellationToken)	Empfangen einer Nachricht von der Gerätewarteschlange mithilfe des Abbruchtokens. Nach der Behandlung einer empfangenen Nachricht sollte ein Client , AbandonAsync(Message, CancellationToken)oder RejectAsync(Message, CancellationToken)aufrufen CompleteAsync(Message, CancellationToken)und die Nachricht dann verwerfen.
ReceiveAsync(TimeSpan)	Empfangen einer Nachricht aus der Gerätewarteschlange mithilfe eines Timeouts. Nach der Behandlung einer empfangenen Nachricht sollte ein Client , AbandonAsync(Message, CancellationToken)oder RejectAsync(Message, CancellationToken)aufrufen CompleteAsync(Message, CancellationToken)und die Nachricht dann verwerfen.
RejectAsync(Message)	Löscht eine empfangene Nachricht aus der Gerätewarteschlange und gibt dem Server an, dass die Nachricht nicht verarbeitet werden konnte.
RejectAsync(Message, CancellationToken)	Löscht eine empfangene Nachricht aus der Gerätewarteschlange und gibt dem Server an, dass die Nachricht nicht verarbeitet werden konnte.
RejectAsync(String)	Löscht eine empfangene Nachricht aus der Gerätewarteschlange und gibt dem Server an, dass die Nachricht nicht verarbeitet werden konnte.
RejectAsync(String, CancellationToken)	Löscht eine empfangene Nachricht aus der Gerätewarteschlange und gibt dem Server an, dass die Nachricht nicht verarbeitet werden konnte.
SendEventAsync(Message)	Sendet ein Ereignis an einen Hub
SendEventAsync(Message, CancellationToken)	Sendet ein Ereignis an einen Hub
SendEventBatchAsync(IEnumerable<Message>)	Sendet einen Batch von Ereignissen an IoT Hub. Verwenden Sie AMQP oder HTTPs für einen echten Batchvorgang. MQTT sendet die Nachrichten einfach nacheinander.
SendEventBatchAsync(IEnumerable<Message>, CancellationToken)	Sendet einen Batch von Ereignissen an IoT Hub. Verwenden Sie AMQP oder HTTPs für einen echten Batchvorgang. MQTT sendet die Nachrichten einfach nacheinander.
SetConnectionStatusChangesHandler(ConnectionStatusChangesHandler)	Legt einen neuen Delegaten für die Verbindung status geänderten Rückrufs fest. Wenn ein Delegat bereits zugeordnet ist, wird er durch den neuen Delegaten ersetzt. Beachten Sie, dass dieser Rückruf nie aufgerufen wird, wenn der Client für die Verwendung von HTTP konfiguriert ist, da dieses Protokoll zustandslos ist.
SetDesiredPropertyUpdateCallback(DesiredPropertyUpdateCallback, Object)	Veraltet. Legen Sie einen Rückruf fest, der immer dann aufgerufen wird, wenn der Client eine Zustandsaktualisierung (gewünscht oder gemeldet) vom Dienst empfängt. Dies hat den Nebeneffekt, dass sie das PATCH-Thema für den Dienst abonnieren.
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object)	Legen Sie einen Rückruf fest, der immer dann aufgerufen wird, wenn der Client eine Zustandsaktualisierung (gewünscht oder gemeldet) vom Dienst empfängt. Legen Sie den Rückrufwert auf NULL fest, um ihn zu löschen.
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object, CancellationToken)	Legen Sie einen Rückruf fest, der immer dann aufgerufen wird, wenn der Client eine Zustandsaktualisierung (gewünscht oder gemeldet) vom Dienst empfängt. Legen Sie den Rückrufwert auf NULL fest, um ihn zu löschen.
SetMethodDefaultHandlerAsync(MethodCallback, Object)	Legt einen neuen Delegaten fest, der für eine Methode aufgerufen wird, für die kein Delegat für ihren Namen registriert ist. Wenn ein Standarddelegat bereits registriert ist, wird er durch den neuen Delegaten ersetzt. Ein Methodenhandler kann durch Übergeben eines Null-MethodCallback-Objekts nicht festgelegt werden.
SetMethodDefaultHandlerAsync(MethodCallback, Object, CancellationToken)	Legt einen neuen Delegaten fest, der für eine Methode aufgerufen wird, für die kein Delegat für ihren Namen registriert ist. Wenn ein Standarddelegat bereits registriert ist, wird er durch den neuen Delegaten ersetzt. Ein Methodenhandler kann durch Übergeben eines Null-MethodCallback-Objekts nicht festgelegt werden.
SetMethodHandler(String, MethodCallback, Object)	Veraltet. Legt einen neuen Delegaten für die benannte Methode fest. Wenn der benannten Methode bereits ein Delegat zugeordnet ist, wird er durch den neuen Delegaten ersetzt.
SetMethodHandlerAsync(String, MethodCallback, Object)	Legt einen neuen Delegaten für die benannte Methode fest. Wenn der benannten Methode bereits ein Delegat zugeordnet ist, wird er durch den neuen Delegaten ersetzt. Ein Methodenhandler kann durch Übergeben eines Null-MethodCallback-Objekts nicht festgelegt werden.
SetMethodHandlerAsync(String, MethodCallback, Object, CancellationToken)	Legt einen neuen Delegaten für die benannte Methode fest. Wenn der benannten Methode bereits ein Delegat zugeordnet ist, wird er durch den neuen Delegaten ersetzt. Ein Methodenhandler kann durch Übergeben eines Null-MethodCallback-Objekts nicht festgelegt werden.
SetReceiveMessageHandlerAsync(ReceiveMessageCallback, Object, CancellationToken)	Legt einen neuen Delegaten für den Empfang einer Nachricht aus der Gerätewarteschlange mithilfe eines Abbruchtokens fest. Nach der Behandlung einer empfangenen Nachricht sollte ein Client , AbandonAsync(Message, CancellationToken)oder RejectAsync(Message, CancellationToken)aufrufen CompleteAsync(Message, CancellationToken)und die Nachricht dann verwerfen. Wenn ein NULL-Delegat übergeben wird, wird der Rückruf deaktiviert, der beim Empfangen von Nachrichten vom Dienst ausgelöst wird.
SetRetryPolicy(IRetryPolicy)	Legt die Wiederholungsrichtlinie fest, die in den Wiederholungsversuchen des Vorgangs verwendet wird. Die Änderung wird nach allen laufenden Vorgängen wirksam.
UpdateReportedPropertiesAsync(TwinCollection)	Übertragen von gemeldeten Eigenschaftsänderungen an den Dienst.
UpdateReportedPropertiesAsync(TwinCollection, CancellationToken)	Übertragen von gemeldeten Eigenschaftsänderungen an den Dienst.
UploadToBlobAsync(String, Stream)	Veraltet. Lädt einen Stream in ein Blockblob in ein Speicherkonto hoch, das dem IoTHub für dieses Gerät zugeordnet ist. Wenn das Blob bereits vorhanden ist, wird es überschrieben.
UploadToBlobAsync(String, Stream, CancellationToken)	Veraltet. Lädt einen Stream in ein Blockblob in ein Speicherkonto hoch, das dem IoTHub für dieses Gerät zugeordnet ist. Wenn das Blob bereits vorhanden ist, wird es überschrieben.