EnrollmentGroupsClient.DeleteAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.TaskPublic Function DeleteAsync (enrollmentGroup As EnrollmentGroup, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- enrollmentGroup
- EnrollmentGroup
The EnrollmentGroup that identifies the enrollmentGroup. It cannot be null.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Exceptions
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.TaskPublic Function DeleteAsync (enrollmentGroupId As String, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- enrollmentGroupId
- String
The string that identifies the enrollmentGroup. It cannot be null or empty.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Exceptions
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
Azure SDK for .NET