DeviceRegistrationStatesClient.GetAsync(String, CancellationToken) 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

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.

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

Task<DeviceRegistrationState>

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.

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 retrieve the registration state for the provided registrationId.

OperationCanceledException

If the provided cancellationToken has requested cancellation.

Applies to

Share via