MessagesClient.PurgeMessageQueueAsync(String, CancellationToken) Método

Definición

Espacio de nombres:

Microsoft.Azure.Devices

Ensamblado:

Microsoft.Azure.Devices.dll

Paquete:

Microsoft.Azure.Devices v2.0.0-preview002

Quita todos los mensajes de la nube al dispositivo de la cola de un dispositivo.

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)

Parámetros

deviceId

String

Identificador del dispositivo de destino.

cancellationToken

CancellationToken

Token de cancelación para cancelar la operación.

Devoluciones

Task<PurgeMessageQueueResult>

PurgeMessageQueueResult.

Excepciones

ArgumentNullException

Cuando el valor proporcionado deviceId es NULL.

ArgumentException

Si está deviceId vacío o espacio en blanco.

IotHubServiceException

Si IoT Hub respondió a la solicitud con un código de estado no correcto. Por ejemplo, si la solicitud proporcionada estaba limitada, IotHubServiceException wit. ThrottlingException se produce.

HttpRequestException

Si se produce un error en la solicitud HTTP debido a un problema subyacente, como la conectividad de red, el error dns o la validación del certificado de servidor.

OperationCanceledException

Si el proporcionado cancellationToken ha solicitado la cancelación.

Comentarios

Esta llamada se realiza a través de HTTP. No es necesario llamar OpenAsync(CancellationToken) a antes de llamar a este método.