EnrollmentGroupsClient.GetAsync(String, CancellationToken) Method

Definition

Namespace:

Microsoft.Azure.Devices.Provisioning.Service

Assembly:

Microsoft.Azure.Devices.Provisioning.Service.dll

Package:

Microsoft.Azure.Devices.Provisioning.Service v2.0.0-preview002

Get an enrollment group by its Id.

public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup> GetAsync (string enrollmentGroupId, System.Threading.CancellationToken cancellationToken = default);

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

Public Function GetAsync (enrollmentGroupId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of EnrollmentGroup)

Parameters

enrollmentGroupId

String

The Id of the enrollmentGroup.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<EnrollmentGroup>

The retrieved enrollment group.

Exceptions

Microsoft.Azure.Devices.Provisioning.Service.DeviceProvisioningServiceException

If the service was not able to retrieve the enrollment group information for the provided enrollmentGroupId.

ArgumentNullException

If the provided enrollmentGroupId is null.

ArgumentException

If the provided enrollmentGroupId is empty or white space.

ProvisioningServiceException

If the service was not able to retrieve the enrollment group information for the provided enrollmentGroupId.

OperationCanceledException

If the provided cancellationToken has requested cancellation.