次の方法で共有

MessagesClient.PurgeMessageQueueAsync(String, CancellationToken) メソッド

  • リファレンス

定義

名前空間:
Microsoft.Azure.Devices
アセンブリ:
Microsoft.Azure.Devices.dll
パッケージ:
Microsoft.Azure.Devices v2.0.0-preview002

デバイスのキューからすべての cloud-to-device メッセージを削除します。

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

ネットワーク接続、DNS エラー、サーバー証明書の検証などの根本的な問題が原因で HTTP 要求が失敗した場合。

OperationCanceledException

指定 cancellationToken された がキャンセルを要求した場合。

注釈

この呼び出しは HTTP 経由で行われます。 このメソッドを呼び出す前に を呼び出 OpenAsync(CancellationToken) す必要はありません。

適用対象