ConfigurationsClient.DeleteAsync メソッド

定義

名前空間:

Microsoft.Azure.Devices

アセンブリ:

Microsoft.Azure.Devices.dll

パッケージ:

Microsoft.Azure.Devices v2.0.0-preview002

オーバーロード

DeleteAsync(String, CancellationToken)	IoT ハブから構成を削除します。
DeleteAsync(Configuration, Boolean, CancellationToken)	IoT ハブから構成を削除します。

DeleteAsync(String, CancellationToken)

IoT ハブから構成を削除します。

public virtual System.Threading.Tasks.Task DeleteAsync(string configurationId, 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 (configurationId As String, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

configurationId

String

削除される構成の ID。

cancellationToken

CancellationToken

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

戻り値

Task

例外

ArgumentNullException

指定 configurationId された が null の場合にスローされます。

ArgumentException

が空または空白の場合に configurationId スローされます。

IotHubServiceException

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

HttpRequestException

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

OperationCanceledException

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

DeleteAsync(Configuration, Boolean, CancellationToken)

IoT ハブから構成を削除します。

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

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

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

パラメーター

configuration

Configuration

削除される構成。

onlyIfUnchanged

Boolean

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

cancellationToken

CancellationToken

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

戻り値

Task

例外

ArgumentNullException

指定 configuration された が null の場合にスローされます。

IotHubServiceException

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

HttpRequestException

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

OperationCanceledException

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