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

ConfigurationsClient.DeleteAsync 方法

定义

重载

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

允许取消操作的标记。

返回

例外

当提供的 configurationId 为 null 时引发。

如果 为空或空格, configurationId 则引发。

如果 IoT 中心使用不成功的状态代码响应请求,则引发。 例如,如果提供的请求受到限制, IotHubServiceException 则会引发 和 ThrottlingException 。 有关可能的错误情况的完整列表,请参阅 IotHubServiceErrorCode

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

如果提供的 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,则即使提供的设备标识的 ETag 已过期,也会执行此删除操作。 如果为 true,则如果提供的配置具有过期的 ETag,则操作将引发 IotHubServiceExceptionPreconditionFailed 。 可以使用 检索 GetAsync(String, CancellationToken)最新的 ETag。

cancellationToken
CancellationToken

允许取消操作的标记。

返回

例外

当提供的 configuration 为 null 时引发。

如果 IoT 中心使用不成功的状态代码响应请求,则引发。 例如,如果提供的请求受到限制, IotHubServiceException 则会引发 和 ThrottlingException 。 有关可能的错误情况的完整列表,请参阅 IotHubServiceErrorCode

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

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

适用于