ProvisioningServiceClient.DeleteEnrollmentGroupAsync Method

Definition

Namespace:

Microsoft.Azure.Devices.Provisioning.Service

Assembly:

Microsoft.Azure.Devices.Provisioning.Service.dll

Package:

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

Overloads

DeleteEnrollmentGroupAsync(EnrollmentGroup)	Delete the enrollmentGroup information.
DeleteEnrollmentGroupAsync(String)	Delete the enrollmentGroup information.
DeleteEnrollmentGroupAsync(EnrollmentGroup, CancellationToken)	Delete the enrollmentGroup information.
DeleteEnrollmentGroupAsync(String, String)	Delete the enrollmentGroup information.
DeleteEnrollmentGroupAsync(String, CancellationToken)	Delete the enrollmentGroup information.
DeleteEnrollmentGroupAsync(String, String, CancellationToken)	Delete the enrollmentGroup information.

DeleteEnrollmentGroupAsync(EnrollmentGroup)

Delete the enrollmentGroup information.

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

Parameters

enrollmentGroup

EnrollmentGroup

the EnrollmentGroup that identifies the enrollmentGroup. It cannot be null.

Returns

Task

Exceptions

ProvisioningServiceClientException

if the Provisioning Device Service was not able to delete the enrollmentGroup information for the provided enrollmentGroup.

Remarks

This method will remove the enrollmentGroup from the Device Provisioning Service using the provided EnrollmentGroup information. The Device Provisioning Service will care about the enrollmentGroupId and the eTag on the enrollmentGroup. If you want to delete the enrollment regardless the eTag, you can set the eTag="*" into the enrollmentGroup, or use the DeleteEnrollmentGroupAsync(String). passing only the enrollmentGroupId.

Note that delete the enrollmentGroup will not remove the Devices itself from the IotHub.

If the enrollmentGroupId does not exists or the eTag does not matches, this method will throw ProvisioningServiceClientException.

DeleteEnrollmentGroupAsync(String)

Delete the enrollmentGroup information.

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

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

Public Function DeleteEnrollmentGroupAsync (enrollmentGroupId As String) As Task

Parameters

enrollmentGroupId

String

the string that identifies the enrollmentGroup. It cannot be null or empty.

Returns

Task

Exceptions

ProvisioningServiceClientException

if the Provisioning Device Service was not able to delete the enrollmentGroup information for the provided enrollmentGroupId.

Remarks

This method will remove the enrollmentGroup from the Device Provisioning Service using the provided enrollmentGroupId. It will delete the enrollmentGroup regardless the eTag. It means that this API correspond to the DeleteEnrollmentGroupAsync(String, String) with the eTag="*".

Note that delete the enrollmentGroup will not remove the Devices itself from the IotHub.

If the enrollmentGroupId does not exists, this method will throw ProvisioningServiceClientException.

DeleteEnrollmentGroupAsync(EnrollmentGroup, CancellationToken)

Delete the enrollmentGroup information.

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

Parameters

enrollmentGroup

EnrollmentGroup

the EnrollmentGroup that identifies the enrollmentGroup. It cannot be null.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task

Exceptions

ProvisioningServiceClientException

if the Provisioning Device Service was not able to delete the enrollmentGroup information for the provided enrollmentGroup.

Remarks

This method will remove the enrollmentGroup from the Device Provisioning Service using the provided EnrollmentGroup information. The Device Provisioning Service will care about the enrollmentGroupId and the eTag on the enrollmentGroup. If you want to delete the enrollment regardless the eTag, you can set the eTag="*" into the enrollmentGroup, or use the DeleteEnrollmentGroupAsync(String). passing only the enrollmentGroupId.

Note that delete the enrollmentGroup will not remove the Devices itself from the IotHub.

If the enrollmentGroupId does not exists or the eTag does not matches, this method will throw ProvisioningServiceClientException.

DeleteEnrollmentGroupAsync(String, String)

Delete the enrollmentGroup information.

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

Parameters

enrollmentGroupId

String

the string that identifies the enrollmentGroup. It cannot be null or empty.

eTag

String

the string with the enrollmentGroup eTag. It can be null or empty. The Device Provisioning Service will ignore it in all of these cases.

Returns

Task

Exceptions

ProvisioningServiceClientException

if the Provisioning Device Service was not able to delete the enrollmentGroup information for the provided enrollmentGroupId and eTag.

Remarks

This method will remove the enrollmentGroup from the Device Provisioning Service using the provided enrollmentGroupId and eTag. If you want to delete the enrollmentGroup regardless the eTag, you can use DeleteEnrollmentGroupAsync(String) or you can pass the eTag as null, empty, or "*".

Note that delete the enrollmentGroup will not remove the Device itself from the IotHub.

If the enrollmentGroupId does not exists or eTag does not matches, this method will throw ProvisioningServiceClientException.

DeleteEnrollmentGroupAsync(String, CancellationToken)

Delete the enrollmentGroup information.

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

Parameters

enrollmentGroupId

String

the string that identifies the enrollmentGroup. It cannot be null or empty.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task

Exceptions

ProvisioningServiceClientException

if the Provisioning Device Service was not able to delete the enrollmentGroup information for the provided enrollmentGroupId.

Remarks

This method will remove the enrollmentGroup from the Device Provisioning Service using the provided enrollmentGroupId. It will delete the enrollmentGroup regardless the eTag. It means that this API correspond to the DeleteEnrollmentGroupAsync(String, String) with the eTag="*".

Note that delete the enrollmentGroup will not remove the Devices itself from the IotHub.

If the enrollmentGroupId does not exists, this method will throw ProvisioningServiceClientException.

DeleteEnrollmentGroupAsync(String, String, CancellationToken)

Delete the enrollmentGroup information.

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

Parameters

enrollmentGroupId

String

the string that identifies the enrollmentGroup. It cannot be null or empty.

eTag

String

the string with the enrollmentGroup eTag. It can be null or empty. The Device Provisioning Service will ignore it in all of these cases.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task

Exceptions

ProvisioningServiceClientException

if the Provisioning Device Service was not able to delete the enrollmentGroup information for the provided enrollmentGroupId and eTag.

Remarks

This method will remove the enrollmentGroup from the Device Provisioning Service using the provided enrollmentGroupId and eTag. If you want to delete the enrollmentGroup regardless the eTag, you can use DeleteEnrollmentGroupAsync(String) or you can pass the eTag as null, empty, or "*".

Note that delete the enrollmentGroup will not remove the Device itself from the IotHub.

If the enrollmentGroupId does not exists or eTag does not matches, this method will throw ProvisioningServiceClientException.