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

DeleteDeviceRegistrationStateAsync(String, String, CancellationToken)	Delete the registration status information.
DeleteDeviceRegistrationStateAsync(String, CancellationToken)	Delete the registration status information.
DeleteDeviceRegistrationStateAsync(String, String)	Delete the registration status information.
DeleteDeviceRegistrationStateAsync(String)	Delete the registration status information.
DeleteDeviceRegistrationStateAsync(DeviceRegistrationState)	Delete the registration status information.
DeleteDeviceRegistrationStateAsync(DeviceRegistrationState, CancellationToken)	Delete the registration status information.

DeleteDeviceRegistrationStateAsync(String, String, CancellationToken)

Delete the registration status information.

public System.Threading.Tasks.Task DeleteDeviceRegistrationStateAsync (string id, string eTag, System.Threading.CancellationToken cancellationToken);

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

Public Function DeleteDeviceRegistrationStateAsync (id As String, eTag As String, cancellationToken As CancellationToken) As Task

Parameters

id

String

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

eTag

String

the string with the DeviceRegistrationState 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 DeviceRegistrationState information for the provided registrationId and eTag.

Remarks

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

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

DeleteDeviceRegistrationStateAsync(String, CancellationToken)

Delete the registration status information.

public System.Threading.Tasks.Task DeleteDeviceRegistrationStateAsync (string id, System.Threading.CancellationToken cancellationToken);

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

Public Function DeleteDeviceRegistrationStateAsync (id As String, cancellationToken As CancellationToken) As Task

Parameters

id

String

the string that identifies the DeviceRegistrationState. 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 DeviceRegistrationState information for the provided registrationId.

Remarks

This method will remove the DeviceRegistrationState from the Device Provisioning Service using the provided id. It will delete the registration status regardless the eTag. It means that this API correspond to the DeleteDeviceRegistrationStateAsync(String, String) with the eTag="*".

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

DeleteDeviceRegistrationStateAsync(String, String)

Delete the registration status information.

public System.Threading.Tasks.Task DeleteDeviceRegistrationStateAsync (string id, string eTag);

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

Public Function DeleteDeviceRegistrationStateAsync (id As String, eTag As String) As Task

Parameters

id

String

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

eTag

String

the string with the DeviceRegistrationState 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 DeviceRegistrationState information for the provided registrationId and eTag.

Remarks

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

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

DeleteDeviceRegistrationStateAsync(String)

Delete the registration status information.

public System.Threading.Tasks.Task DeleteDeviceRegistrationStateAsync (string id);

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

Public Function DeleteDeviceRegistrationStateAsync (id As String) As Task

Parameters

id

String

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

Returns

Task

Exceptions

ProvisioningServiceClientException

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

Remarks

This method will remove the DeviceRegistrationState from the Device Provisioning Service using the provided id. It will delete the registration status regardless the eTag. It means that this API correspond to the DeleteDeviceRegistrationStateAsync(String, String) with the eTag="*".

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

DeleteDeviceRegistrationStateAsync(DeviceRegistrationState)

Delete the registration status information.

public System.Threading.Tasks.Task DeleteDeviceRegistrationStateAsync (Microsoft.Azure.Devices.Provisioning.Service.DeviceRegistrationState deviceRegistrationState);

member this.DeleteDeviceRegistrationStateAsync : Microsoft.Azure.Devices.Provisioning.Service.DeviceRegistrationState -> System.Threading.Tasks.Task

Public Function DeleteDeviceRegistrationStateAsync (deviceRegistrationState As DeviceRegistrationState) As Task

Parameters

deviceRegistrationState

DeviceRegistrationState

the DeviceRegistrationState that identifies the DeviceRegistrationState. It cannot be null.

Returns

Task

Exceptions

ProvisioningServiceClientException

if the Provisioning Device Service was not able to delete the registration status information for the provided DeviceRegistrationState.

Remarks

This method will remove the DeviceRegistrationState from the Device Provisioning Service using the provided DeviceRegistrationState information. The Device Provisioning Service will care about the id and the eTag on the DeviceRegistrationState. If you want to delete the DeviceRegistrationState regardless the eTag, you can use the DeleteDeviceRegistrationStateAsync(String) passing only the id.

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

DeleteDeviceRegistrationStateAsync(DeviceRegistrationState, CancellationToken)

Delete the registration status information.

public System.Threading.Tasks.Task DeleteDeviceRegistrationStateAsync (Microsoft.Azure.Devices.Provisioning.Service.DeviceRegistrationState deviceRegistrationState, System.Threading.CancellationToken cancellationToken);

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

Public Function DeleteDeviceRegistrationStateAsync (deviceRegistrationState As DeviceRegistrationState, cancellationToken As CancellationToken) As Task

Parameters

deviceRegistrationState

DeviceRegistrationState

the DeviceRegistrationState that identifies the DeviceRegistrationState. It cannot be null.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task

Exceptions

ProvisioningServiceClientException

if the Provisioning Device Service was not able to delete the registration status information for the provided DeviceRegistrationState.

Remarks

This method will remove the DeviceRegistrationState from the Device Provisioning Service using the provided DeviceRegistrationState information. The Device Provisioning Service will care about the id and the eTag on the DeviceRegistrationState. If you want to delete the DeviceRegistrationState regardless the eTag, you can use the DeleteDeviceRegistrationStateAsync(String) passing only the id.

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