MessagesClient.PurgeMessageQueueAsync(String, CancellationToken) Methode

Referenz

Definition

Namespace:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

Paket:: Microsoft.Azure.Devices v2.0.0-preview002

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Entfernt alle C2D-Nachrichten aus der Warteschlange eines Geräts.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.PurgeMessageQueueResult> PurgeMessageQueueAsync (string deviceId, System.Threading.CancellationToken cancellationToken = default);

abstract member PurgeMessageQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.PurgeMessageQueueResult>
override this.PurgeMessageQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.PurgeMessageQueueResult>

Public Overridable Function PurgeMessageQueueAsync (deviceId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PurgeMessageQueueResult)

Parameter

deviceId: String

Der Gerätebezeichner für das Zielgerät.

cancellationToken: CancellationToken

Ein Abbruchtoken, um den Vorgang abzubrechen.

Gibt zurück

Task<PurgeMessageQueueResult>

Die PurgeMessageQueueResult.

Ausnahmen

ArgumentNullException

Wenn das bereitgestellte deviceId null ist.

ArgumentException

Wenn leer deviceId oder leer ist.

IotHubServiceException

Wenn IoT Hub auf die Anforderung mit einem nicht erfolgreichen status Code reagiert hat. Wenn z. B. die bereitgestellte Anforderung gedrosselt wurde, IotHubServiceException mit . ThrottlingException wird ausgelöst.

HttpRequestException

Wenn die HTTP-Anforderung aufgrund eines zugrunde liegenden Problems fehlschlägt, z. B. Netzwerkkonnektivität, DNS-Fehler oder Serverzertifikatüberprüfung.

OperationCanceledException

Wenn der bereitgestellte cancellationToken einen Abbruch angefordert hat.

Hinweise

Dieser Aufruf erfolgt über HTTP. Es ist nicht erforderlich, vor dem Aufrufen dieser Methode aufzurufen OpenAsync(CancellationToken) .

Gilt für:

Freigeben über