ModulesClient.DeleteAsync メソッド

定義

名前空間:

Microsoft.Azure.Devices

アセンブリ:

Microsoft.Azure.Devices.dll

パッケージ:

Microsoft.Azure.Devices v2.0.0-preview002

オーバーロード

DeleteAsync(Module, Boolean, CancellationToken)	IoT ハブのレジストリからモジュール ID を削除します。
DeleteAsync(String, String, CancellationToken)	指定された ID を持つモジュール ID を、IoT ハブのレジストリから指定された ID を持つデバイスから削除します。

DeleteAsync(Module, Boolean, CancellationToken)

IoT ハブのレジストリからモジュール ID を削除します。

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

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

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

パラメーター

module

Module

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

onlyIfUnchanged

Boolean

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

cancellationToken

CancellationToken

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

戻り値

Task

例外

ArgumentNullException

指定されたモジュールが null の場合にスローされます。

IotHubServiceException

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

HttpRequestException

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

OperationCanceledException

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

DeleteAsync(String, String, CancellationToken)

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

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

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

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

パラメーター

deviceId

String

削除するモジュールを含むデバイス ID の ID。

moduleId

String

削除するモジュール ID の ID。

cancellationToken

CancellationToken

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

戻り値

Task

例外

ArgumentNullException

指定されたデバイス ID またはモジュール ID が null の場合にスローされます。

ArgumentException

指定されたデバイス ID またはモジュール ID が空または空白の場合にスローされます。

IotHubServiceException

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

HttpRequestException

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

OperationCanceledException

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