DevicesClient.DeleteAsync メソッド

リファレンス

定義

名前空間:: Microsoft.Azure.Devices

アセンブリ:: Microsoft.Azure.Devices.dll

パッケージ:: Microsoft.Azure.Devices v2.0.0-preview002

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

オーバーロード

DeleteAsync(String, CancellationToken)	指定された ID を持つデバイス ID を IoT ハブのレジストリから削除します。
DeleteAsync(Device, Boolean, CancellationToken)	指定された ID を持つデバイス ID を IoT ハブのレジストリから削除します。
DeleteAsync(IEnumerable<Device>, Boolean, CancellationToken)	IoT ハブのレジストリから最大 100 個のデバイス ID を一括で削除します。

DeleteAsync(String, CancellationToken)

指定された ID を持つデバイス ID を IoT ハブのレジストリから削除します。

public virtual System.Threading.Tasks.Task DeleteAsync (string deviceId, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function DeleteAsync (deviceId As String, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

deviceId: String

削除するデバイス ID の ID。

cancellationToken: CancellationToken

操作を取り消すトークン。

戻り値

Task

例外

ArgumentNullException

指定されたデバイス ID が null の場合。

ArgumentException

指定されたデバイス ID が空または空白の場合。

IotHubServiceException

IoT ハブが失敗した状態コードで要求に応答した場合。たとえば、指定された要求が調整された場合、 IotHubServiceException が ThrottlingException スローされます。考えられるエラーケースの完全な一覧については、「」を参照してください IotHubServiceErrorCode。

HttpRequestException

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

OperationCanceledException

指定されたキャンセルトークンが取り消しを要求した場合。

適用対象

DeleteAsync(Device, Boolean, CancellationToken)

指定された ID を持つデバイス ID を IoT ハブのレジストリから削除します。

public virtual System.Threading.Tasks.Task DeleteAsync (Microsoft.Azure.Devices.Device device, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteAsync : Microsoft.Azure.Devices.Device * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteAsync : Microsoft.Azure.Devices.Device * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function DeleteAsync (device As Device, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

device: Device

IoT ハブのレジストリから削除するデバイス ID。指定されたデバイスの ETag が古い場合、この操作はをスロー IotHubServiceException し PreconditionFailed 、を使用して GetAsync(String, CancellationToken)最新の ETag を取得できます。 ETag に関係なく操作を強制的に実行するには、デバイス ID の ETag を "*" に設定するか、を使用 DeleteAsync(String, CancellationToken)します。

onlyIfUnchanged: Boolean

false の場合、指定されたデバイス ID に期限切れの ETag がある場合でも、この削除操作が実行されます。 true の場合、指定されたデバイス ID に期限切れの ETag がある場合、操作は with PreconditionFailed をスローIotHubServiceExceptionします。を使用して GetAsync(String, CancellationToken)、最新の ETag を取得できます。

cancellationToken: CancellationToken