你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

MessagesClient.PurgeMessageQueueAsync(String, CancellationToken) 方法

定义

命名空间:

Microsoft.Azure.Devices

程序集:

Microsoft.Azure.Devices.dll

包:

Microsoft.Azure.Devices v2.0.0-preview002

从设备队列中删除所有云到设备的消息。

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)

参数

deviceId

String

目标设备的设备标识符。

cancellationToken

CancellationToken

用于取消操作的取消标记。

返回

Task<PurgeMessageQueueResult>

PurgeMessageQueueResult

例外

ArgumentNullException

当提供的 deviceId 为 null 时。

ArgumentException

如果 为 deviceId 空或空格。

IotHubServiceException

如果 IoT 中心使用不成功的状态代码响应了请求。 例如，如果提供的请求受到限制， IotHubServiceException 则 wit。 ThrottlingException 引发 。

HttpRequestException

如果 HTTP 请求因网络连接、DNS 故障或服务器证书验证等基础问题而失败。

OperationCanceledException

如果提供的 cancellationToken 已请求取消。

注解

此调用是通过 HTTP 进行的。 在调用此方法之前，无需调用 OpenAsync(CancellationToken) 。