Share via


DeviceRegistrationStatesClient.GetAsync(String, CancellationToken) Method

Definition

Get the device registration state.

public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Service.DeviceRegistrationState> GetAsync (string registrationId, System.Threading.CancellationToken cancellationToken = default);
member this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Service.DeviceRegistrationState>
Public Function GetAsync (registrationId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DeviceRegistrationState)

Parameters

registrationId
String

The Id of the registration to get the state of.

cancellationToken
CancellationToken

The cancellation token.

Returns

The DeviceRegistrationState with the content of the DeviceRegistrationState in the Provisioning Device Service.

Exceptions

Microsoft.Azure.Devices.Provisioning.Service.DeviceProvisioningServiceException

If the service was not able to retrieve 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 retrieve the registration state for the provided registrationId.

If the provided cancellationToken has requested cancellation.

Applies to