Udostępnij za pośrednictwem

DeviceRegistrationStatesClient.DeleteAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Devices.Provisioning.Service
Assembly:
Microsoft.Azure.Devices.Provisioning.Service.dll
Package:
Microsoft.Azure.Devices.Provisioning.Service v2.0.0-preview002

Overloads

DeleteAsync(DeviceRegistrationState, CancellationToken)

Delete the device registration.
DeleteAsync(String, CancellationToken)

Delete the device registration.

DeleteAsync(DeviceRegistrationState, CancellationToken)

Delete the device registration.

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

Parameters

deviceRegistrationState
DeviceRegistrationState

The device registration to delete.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task

Exceptions

Microsoft.Azure.Devices.Provisioning.Service.DeviceProvisioningServiceException

When the service wasn't able to delete the registration status.

ArgumentNullException

If the provided deviceRegistrationState is null.

ProvisioningServiceException

When the service wasn't able to delete the registration status.

OperationCanceledException

If the provided cancellationToken has requested cancellation.

Applies to

DeleteAsync(String, CancellationToken)

Delete the device registration.

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

Parameters

registrationId
String

The Id of the device registration to delete.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task

Exceptions

Microsoft.Azure.Devices.Provisioning.Service.DeviceProvisioningServiceException

If the service was not able to delete the registration state for the provided registrationId.

ArgumentNullException

If the provided registrationId is null.

ArgumentException

If the provided registrationId is empty or white space.

ProvisioningServiceException

If the service was not able to delete the registration state for the provided registrationId.

OperationCanceledException

If the provided cancellationToken has requested cancellation.

Applies to