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

ModulesClient.DeleteAsync 方法

参考

定义

命名空间:: Microsoft.Azure.Devices

程序集:: Microsoft.Azure.Devices.dll

包:: Microsoft.Azure.Devices v2.0.0-preview002

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

重载

DeleteAsync(Module, Boolean, CancellationToken)	从 IoT 中心的注册表中删除模块标识。
DeleteAsync(String, String, CancellationToken)	使用 IoT 中心的注册表提供的 ID 从设备中删除具有提供的 ID 的模块标识。

DeleteAsync(Module, Boolean, CancellationToken)

从 IoT 中心的注册表中删除模块标识。

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 中心的注册表中删除的模块标识。如果提供的模块的 ETag 已过期，此操作将引发， IotHubServiceException 并且 PreconditionFailed 可以使用检索 GetAsync(String, String, CancellationToken)最新的 ETag。若要强制执行操作而不考虑 ETag，请将模块标识的 ETag 设置为“*”或使用 DeleteAsync(String, String, CancellationToken)。

onlyIfUnchanged: Boolean

如果为 false，则即使提供的设备标识的 ETag 已过期，也会执行此删除操作。如果为 true，则如果提供的模块具有过期的 ETag，则操作将引发 IotHubServiceException PreconditionFailed 。可以使用检索 GetAsync(String, String, CancellationToken)最新的 ETag。

cancellationToken: CancellationToken

允许取消操作的令牌。

Task

例外

ArgumentNullException

当提供的模块为 null 时引发。

IotHubServiceException

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

HttpRequestException

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

OperationCanceledException

如果提供的取消令牌已请求取消。

适用于

DeleteAsync(String, String, CancellationToken)

使用 IoT 中心的注册表提供的 ID 从设备中删除具有提供的 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。

moduleId: String

要删除的模块标识的 ID。

cancellationToken: CancellationToken