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

GetIndividualEnrollmentAsync(String)	Retrieve the individualEnrollment information.
GetIndividualEnrollmentAsync(String, CancellationToken)	Gets the individual enrollment object.

GetIndividualEnrollmentAsync(String)

Retrieve the individualEnrollment information.

public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Service.IndividualEnrollment> GetIndividualEnrollmentAsync (string registrationId);

member this.GetIndividualEnrollmentAsync : string -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Service.IndividualEnrollment>

Public Function GetIndividualEnrollmentAsync (registrationId As String) As Task(Of IndividualEnrollment)

Parameters

registrationId

String

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

Returns

Task<IndividualEnrollment>

The IndividualEnrollment with the content of the individualEnrollment in the Provisioning Device Service.

Exceptions

ArgumentException

if the provided parameter is not correct.

ProvisioningServiceClientTransportException

if the SDK failed to send the request to the Device Provisioning Service.

ProvisioningServiceClientException

if the Device Provisioning Service was not able to execute the bulk operation.

Remarks

This method will return the enrollment information for the provided registrationId. It will retrieve the correspondent individualEnrollment from the Device Provisioning Service, and return it in the IndividualEnrollment object.

If the registrationId do not exists, this method will throw ProvisioningServiceClientException.

GetIndividualEnrollmentAsync(String, CancellationToken)

Gets the individual enrollment object.

public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Service.IndividualEnrollment> GetIndividualEnrollmentAsync (string registrationId, System.Threading.CancellationToken cancellationToken);

member this.GetIndividualEnrollmentAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Service.IndividualEnrollment>

Public Function GetIndividualEnrollmentAsync (registrationId As String, cancellationToken As CancellationToken) As Task(Of IndividualEnrollment)

Parameters

registrationId

String

The registration Id.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<IndividualEnrollment>