ProvisioningServiceClient.DeleteIndividualEnrollmentAsync 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

DeleteIndividualEnrollmentAsync(String, String, CancellationToken)	Deletes an individual enrollment if the eTag matches.
DeleteIndividualEnrollmentAsync(String, String)	Delete the individualEnrollment information.
DeleteIndividualEnrollmentAsync(String, CancellationToken)	Delete the individualEnrollment information.
DeleteIndividualEnrollmentAsync(String)	Delete the individualEnrollment information.
DeleteIndividualEnrollmentAsync(IndividualEnrollment)	Delete the individualEnrollment information.
DeleteIndividualEnrollmentAsync(IndividualEnrollment, CancellationToken)	Deletes an individual enrollment.

DeleteIndividualEnrollmentAsync(String, String, CancellationToken)

Deletes an individual enrollment if the eTag matches.

public System.Threading.Tasks.Task DeleteIndividualEnrollmentAsync (string registrationId, string eTag, System.Threading.CancellationToken cancellationToken);

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

Public Function DeleteIndividualEnrollmentAsync (registrationId As String, eTag As String, cancellationToken As CancellationToken) As Task

Parameters

registrationId

String

The registration id

eTag

String

The eTag.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task

DeleteIndividualEnrollmentAsync(String, String)

Delete the individualEnrollment information.

public System.Threading.Tasks.Task DeleteIndividualEnrollmentAsync (string registrationId, string eTag);

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

Public Function DeleteIndividualEnrollmentAsync (registrationId As String, eTag As String) As Task

Parameters

registrationId

String

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

eTag

String

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

Returns

Task

Exceptions

ArgumentException

if the provided registrationId is not correct.

ProvisioningServiceClientTransportException

if the SDK failed to send the request to the Device Provisioning Service.

ProvisioningServiceClientException

if the Device Provisioning Service was not able to execute the bulk operation.

Remarks

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

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

If the registrationId does not exists or the eTag does not matches, this method will throw ProvisioningServiceClientException. For more exceptions that this method can throw, please see

DeleteIndividualEnrollmentAsync(String, CancellationToken)

Delete the individualEnrollment information.

public System.Threading.Tasks.Task DeleteIndividualEnrollmentAsync (string registrationId, System.Threading.CancellationToken cancellationToken);

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

Public Function DeleteIndividualEnrollmentAsync (registrationId As String, cancellationToken As CancellationToken) As Task

Parameters

registrationId

String

the string} that identifies the individualEnrollment. It cannot be {@code null or empty.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task

Exceptions

ArgumentException

if the provided registrationId is not correct.

ProvisioningServiceClientTransportException

if the SDK failed to send the request to the Device Provisioning Service.

ProvisioningServiceClientException

if the Device Provisioning Service was not able to execute the bulk operation.

Remarks

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

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

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

DeleteIndividualEnrollmentAsync(String)

Delete the individualEnrollment information.

public System.Threading.Tasks.Task DeleteIndividualEnrollmentAsync (string registrationId);

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

Public Function DeleteIndividualEnrollmentAsync (registrationId As String) As Task

Parameters

registrationId

String

the string} that identifies the individualEnrollment. It cannot be {@code null or empty.

Returns

Task

Exceptions

ArgumentException

if the provided registrationId is not correct.

ProvisioningServiceClientTransportException

if the SDK failed to send the request to the Device Provisioning Service.

ProvisioningServiceClientException

if the Device Provisioning Service was not able to execute the bulk operation.

Remarks

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

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

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

DeleteIndividualEnrollmentAsync(IndividualEnrollment)

Delete the individualEnrollment information.

public System.Threading.Tasks.Task DeleteIndividualEnrollmentAsync (Microsoft.Azure.Devices.Provisioning.Service.IndividualEnrollment individualEnrollment);

member this.DeleteIndividualEnrollmentAsync : Microsoft.Azure.Devices.Provisioning.Service.IndividualEnrollment -> System.Threading.Tasks.Task

Public Function DeleteIndividualEnrollmentAsync (individualEnrollment As IndividualEnrollment) As Task

Parameters

individualEnrollment

IndividualEnrollment

the IndividualEnrollment that identifies the individualEnrollment. It cannot be null.

Returns

Task

Exceptions

ArgumentException

if the provided parameter is not correct.

ProvisioningServiceClientTransportException

if the SDK failed to send the request to the Device Provisioning Service.

ProvisioningServiceClientException

if the Device Provisioning Service was not able to execute the bulk operation.

Remarks

This method will remove the individualEnrollment from the Device Provisioning Service using the provided IndividualEnrollment information. The Device Provisioning Service will care about the registrationId and the eTag on the individualEnrollment. If you want to delete the individualEnrollment regardless the eTag, you can set the eTag="*"} into the individualEnrollment, or use the {@link #deleteIndividualEnrollment(string) passing only the registrationId.

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

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

DeleteIndividualEnrollmentAsync(IndividualEnrollment, CancellationToken)

Deletes an individual enrollment.

public System.Threading.Tasks.Task DeleteIndividualEnrollmentAsync (Microsoft.Azure.Devices.Provisioning.Service.IndividualEnrollment individualEnrollment, System.Threading.CancellationToken cancellationToken);

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

Public Function DeleteIndividualEnrollmentAsync (individualEnrollment As IndividualEnrollment, cancellationToken As CancellationToken) As Task

Parameters

individualEnrollment

IndividualEnrollment

The individual enrollment.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task