DeviceRegistrationStatesClient.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(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.TaskPublic Function DeleteAsync (deviceRegistrationState As DeviceRegistrationState, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- deviceRegistrationState
- DeviceRegistrationState
The device registration to delete.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Exceptions
When the service wasn't able to delete the registration status.
If the provided deviceRegistrationState is null.
When the service wasn't able to delete the registration status.
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.TaskPublic Function DeleteAsync (registrationId As String, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- registrationId
- String
The Id of the device registration to delete.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Exceptions
If the service was not able to delete the registration state for the provided registrationId.
If the provided registrationId is null.
If the provided registrationId is empty or white space.
If the service was not able to delete the registration state for the provided registrationId.
If the provided cancellationToken has requested cancellation.
