MessagesClient.PurgeMessageQueueAsync(String, CancellationToken) Méthode

Définition

Espace de noms:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Paquet:

Microsoft.Azure.Devices v2.0.0-preview002

Supprime tous les messages cloud-à-appareil de la file d’attente d’un appareil.

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)

Paramètres

deviceId

String

Identificateur de l’appareil cible.

cancellationToken

CancellationToken

Jeton d’annulation pour annuler l’opération.

Retours

Task<PurgeMessageQueueResult>

L’PurgeMessageQueueResultopérateur

Exceptions

ArgumentNullException

Lorsque le fourni deviceId a la valeur Null.

ArgumentException

Si est deviceId vide ou espace blanc.

IotHubServiceException

Si IoT Hub a répondu à la demande avec un code de status non réussi. Par exemple, si la requête fournie a été limitée, IotHubServiceException wit. ThrottlingException est levée.

HttpRequestException

Si la requête HTTP échoue en raison d’un problème sous-jacent tel que la connectivité réseau, l’échec DNS ou la validation du certificat de serveur.

OperationCanceledException

Si le fourni cancellationToken a demandé l’annulation.

Remarques

Cet appel est effectué via HTTP. Il n’est pas nécessaire d’appeler OpenAsync(CancellationToken) avant d’appeler cette méthode.