EnrollmentGroupsClient.GetAsync(String, CancellationToken) 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.
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
The retrieved enrollment group.
Exceptions
If the service was not able to retrieve the enrollment group information for the provided enrollmentGroupId
.
If the provided enrollmentGroupId
is null.
If the provided enrollmentGroupId
is empty or white space.
If the service was not able to retrieve the enrollment group information for the provided enrollmentGroupId
.
If the provided cancellationToken
has requested cancellation.