MessagesClient.PurgeMessageQueueAsync(String, CancellationToken) Método

Definição

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Pacote:

Microsoft.Azure.Devices v2.0.0-preview002

Remove todas as mensagens da nuvem para o dispositivo da fila de um 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

O identificador de dispositivo para o dispositivo de destino.

cancellationToken

CancellationToken

Um token de cancelamento para cancelar a operação.

Retornos

Task<PurgeMessageQueueResult>

O PurgeMessageQueueResult.

Exceções

ArgumentNullException

Quando o fornecido deviceId for nulo.

ArgumentException

Se o deviceId estiver vazio ou espaço em branco.

IotHubServiceException

Se o Hub IoT respondeu à solicitação com um código de status não bem-sucedido. Por exemplo, se a solicitação fornecida foi limitada, IotHubServiceException wit. ThrottlingException é lançado.

HttpRequestException

Se a solicitação HTTP falhar devido a um problema subjacente, como conectividade de rede, falha de DNS ou validação de certificado do servidor.

OperationCanceledException

Se o fornecido cancellationToken tiver solicitado o cancelamento.

Comentários

Essa chamada é feita via HTTP. Não é necessário chamar OpenAsync(CancellationToken) antes de chamar esse método.