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

ProvisioningServiceClient.DeleteEnrollmentGroupAsync 方法

定义

命名空间:

Microsoft.Azure.Devices.Provisioning.Service

程序集:

Microsoft.Azure.Devices.Provisioning.Service.dll

包:

Microsoft.Azure.Devices.Provisioning.Service v1.18.1

重载

DeleteEnrollmentGroupAsync(EnrollmentGroup)	删除 enrollmentGroup 信息。
DeleteEnrollmentGroupAsync(String)	删除 enrollmentGroup 信息。
DeleteEnrollmentGroupAsync(EnrollmentGroup, CancellationToken)	删除 enrollmentGroup 信息。
DeleteEnrollmentGroupAsync(String, String)	删除 enrollmentGroup 信息。
DeleteEnrollmentGroupAsync(String, CancellationToken)	删除 enrollmentGroup 信息。
DeleteEnrollmentGroupAsync(String, String, CancellationToken)	删除 enrollmentGroup 信息。

DeleteEnrollmentGroupAsync(EnrollmentGroup)

删除 enrollmentGroup 信息。

public System.Threading.Tasks.Task DeleteEnrollmentGroupAsync (Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup enrollmentGroup);

member this.DeleteEnrollmentGroupAsync : Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup -> System.Threading.Tasks.Task

Public Function DeleteEnrollmentGroupAsync (enrollmentGroup As EnrollmentGroup) As Task

参数

enrollmentGroup

EnrollmentGroup

EnrollmentGroup标识 enrollmentGroup 的 。 它不能为 null。

返回

Task

例外

ProvisioningServiceClientException

如果预配设备服务无法删除提供的 enrollmentGroup 的 enrollmentGroup 信息，则为 。

注解

此方法将使用提供的信息 EnrollmentGroup 从设备预配服务中删除 enrollmentGroup。 设备预配服务将关注 enrollmentGroup 上的 enrollmentGroupId 和 eTag。 如果要删除注册而不考虑 eTag，可以将 设置为 eTag="*" enrollmentGroup，或使用 DeleteEnrollmentGroupAsync(String)。 仅传递 enrollmentGroupId。

请注意，删除 enrollmentGroup 不会从 IotHub 中删除设备本身。

如果 enrollmentGroupId 不存在或 eTag 不匹配，此方法将引发 ProvisioningServiceClientException。

DeleteEnrollmentGroupAsync(String)

删除 enrollmentGroup 信息。

public System.Threading.Tasks.Task DeleteEnrollmentGroupAsync (string enrollmentGroupId);

member this.DeleteEnrollmentGroupAsync : string -> System.Threading.Tasks.Task

Public Function DeleteEnrollmentGroupAsync (enrollmentGroupId As String) As Task

参数

enrollmentGroupId

String

string标识 enrollmentGroup 的 。 它不能为 null 或为空。

返回

Task

例外

ProvisioningServiceClientException

如果预配设备服务无法删除提供的 enrollmentGroupId 的 enrollmentGroup 信息，则为 。

注解

此方法将使用提供的 enrollmentGroupId 从设备预配服务中删除 enrollmentGroup。 无论 eTag 如何，它都会删除 enrollmentGroup。 这意味着此 API 对应于 DeleteEnrollmentGroupAsync(String, String) 具有 的 eTag="*"。

请注意，删除 enrollmentGroup 不会从 IotHub 中删除设备本身。

如果 enrollmentGroupId 不存在，此方法将引发 ProvisioningServiceClientException。

DeleteEnrollmentGroupAsync(EnrollmentGroup, CancellationToken)

删除 enrollmentGroup 信息。

public System.Threading.Tasks.Task DeleteEnrollmentGroupAsync (Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup enrollmentGroup, System.Threading.CancellationToken cancellationToken);

member this.DeleteEnrollmentGroupAsync : Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function DeleteEnrollmentGroupAsync (enrollmentGroup As EnrollmentGroup, cancellationToken As CancellationToken) As Task

参数

enrollmentGroup

EnrollmentGroup

EnrollmentGroup标识 enrollmentGroup 的 。 它不能为 null。

cancellationToken

CancellationToken

取消标记。

返回

Task

例外

ProvisioningServiceClientException

如果预配设备服务无法删除提供的 enrollmentGroup 的 enrollmentGroup 信息，则为 。

注解

此方法将使用提供的信息 EnrollmentGroup 从设备预配服务中删除 enrollmentGroup。 设备预配服务将关注 enrollmentGroup 上的 enrollmentGroupId 和 eTag。 如果要删除注册而不考虑 eTag，可以将 设置为 eTag="*" enrollmentGroup，或使用 DeleteEnrollmentGroupAsync(String)。 仅传递 enrollmentGroupId。

请注意，删除 enrollmentGroup 不会从 IotHub 中删除设备本身。

如果 enrollmentGroupId 不存在或 eTag 不匹配，此方法将引发 ProvisioningServiceClientException。

DeleteEnrollmentGroupAsync(String, String)

删除 enrollmentGroup 信息。

public System.Threading.Tasks.Task DeleteEnrollmentGroupAsync (string enrollmentGroupId, string eTag);

member this.DeleteEnrollmentGroupAsync : string * string -> System.Threading.Tasks.Task

Public Function DeleteEnrollmentGroupAsync (enrollmentGroupId As String, eTag As String) As Task

参数

enrollmentGroupId

String

string标识 enrollmentGroup 的 。 它不能为 null 或为空。

eTag

String

具有 string enrollmentGroup eTag 的 。 它可以为 null 或空。 在所有这些情况下，设备预配服务都将忽略它。

返回

Task

例外

ProvisioningServiceClientException

如果预配设备服务无法删除提供的 enrollmentGroupId 和 eTag 的 enrollmentGroup 信息，则为 。

注解

此方法将使用提供的 enrollmentGroupId 和 eTag 从设备预配服务中删除 enrollmentGroup。 如果要删除 enrollmentGroup 而不考虑 eTag，可以使用 DeleteEnrollmentGroupAsync(String) 或将 eTag 作为 null、空或 "*"传递。

请注意，删除 enrollmentGroup 不会从 IotHub 中删除设备本身。

如果 enrollmentGroupId 不存在或 eTag 不匹配，此方法将引发 ProvisioningServiceClientException。

DeleteEnrollmentGroupAsync(String, CancellationToken)

删除 enrollmentGroup 信息。

public System.Threading.Tasks.Task DeleteEnrollmentGroupAsync (string enrollmentGroupId, System.Threading.CancellationToken cancellationToken);

member this.DeleteEnrollmentGroupAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function DeleteEnrollmentGroupAsync (enrollmentGroupId As String, cancellationToken As CancellationToken) As Task

参数

enrollmentGroupId

String

string标识 enrollmentGroup 的 。 它不能为 null 或为空。

cancellationToken

CancellationToken

取消标记。

返回

Task

例外

ProvisioningServiceClientException

如果预配设备服务无法删除提供的 enrollmentGroupId 的 enrollmentGroup 信息，则为 。

注解

此方法将使用提供的 enrollmentGroupId 从设备预配服务中删除 enrollmentGroup。 无论 eTag 如何，它都会删除 enrollmentGroup。 这意味着此 API 对应于 DeleteEnrollmentGroupAsync(String, String) 具有 的 eTag="*"。

请注意，删除 enrollmentGroup 不会从 IotHub 中删除设备本身。

如果 enrollmentGroupId 不存在，此方法将引发 ProvisioningServiceClientException。

DeleteEnrollmentGroupAsync(String, String, CancellationToken)

删除 enrollmentGroup 信息。

public System.Threading.Tasks.Task DeleteEnrollmentGroupAsync (string enrollmentGroupId, string eTag, System.Threading.CancellationToken cancellationToken);

member this.DeleteEnrollmentGroupAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function DeleteEnrollmentGroupAsync (enrollmentGroupId As String, eTag As String, cancellationToken As CancellationToken) As Task

参数

enrollmentGroupId

String

string标识 enrollmentGroup 的 。 它不能为 null 或为空。

eTag

String

具有 string enrollmentGroup eTag 的 。 它可以为 null 或空。 在所有这些情况下，设备预配服务都将忽略它。

cancellationToken

CancellationToken

取消标记。

返回

Task

例外

ProvisioningServiceClientException

如果预配设备服务无法删除提供的 enrollmentGroupId 和 eTag 的 enrollmentGroup 信息，则为 。

注解

此方法将使用提供的 enrollmentGroupId 和 eTag 从设备预配服务中删除 enrollmentGroup。 如果要删除 enrollmentGroup 而不考虑 eTag，可以使用 DeleteEnrollmentGroupAsync(String) 或将 eTag 作为 null、空或 "*"传递。

请注意，删除 enrollmentGroup 不会从 IotHub 中删除设备本身。

如果 enrollmentGroupId 不存在或 eTag 不匹配，此方法将引发 ProvisioningServiceClientException。