Share via


EnrollmentGroupsClient.DeleteAsync Method

Definition

Overloads

DeleteAsync(EnrollmentGroup, CancellationToken)

Delete the enrollment group information.

DeleteAsync(String, CancellationToken)

Delete an enrollment group.

DeleteAsync(EnrollmentGroup, CancellationToken)

Delete the enrollment group information.

public System.Threading.Tasks.Task DeleteAsync (Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup enrollmentGroup, System.Threading.CancellationToken cancellationToken = default);
member this.DeleteAsync : Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function DeleteAsync (enrollmentGroup As EnrollmentGroup, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

enrollmentGroup
EnrollmentGroup

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

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Microsoft.Azure.Devices.Provisioning.Service.DeviceProvisioningServiceException

If the service was not able to delete the enrollment group information for the provided enrollmentGroup.

If the provided enrollmentGroup is null.

If the service was not able to delete the enrollment group information for the provided enrollmentGroup.

If the provided cancellationToken has requested cancellation.

Applies to

DeleteAsync(String, CancellationToken)

Delete an enrollment group.

public System.Threading.Tasks.Task DeleteAsync (string enrollmentGroupId, System.Threading.CancellationToken cancellationToken = default);
member this.DeleteAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function DeleteAsync (enrollmentGroupId As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

enrollmentGroupId
String

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

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Microsoft.Azure.Devices.Provisioning.Service.DeviceProvisioningServiceException

If the service was not able to delete the enrollment group information for the provided enrollmentGroupId.

If the provided enrollmentGroupId is null.

If the provided enrollmentGroupId is empty or white space.

If the service was not able to delete the enrollment group information for the provided enrollmentGroupId.

If the provided cancellationToken has requested cancellation.

Applies to