ProvisioningServiceClient.GetEnrollmentGroupAsync 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.
Overloads
| GetEnrollmentGroupAsync(String) |
Retrieve the enrollmentGroup information. |
| GetEnrollmentGroupAsync(String, CancellationToken) |
Retrieve the enrollmentGroup information. |
GetEnrollmentGroupAsync(String)
Retrieve the enrollmentGroup information.
public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup> GetEnrollmentGroupAsync (string enrollmentGroupId);member this.GetEnrollmentGroupAsync : string -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup>Public Function GetEnrollmentGroupAsync (enrollmentGroupId As String) As Task(Of EnrollmentGroup)Parameters
- enrollmentGroupId
- String
the string that identifies the enrollmentGroup. It cannot be null or empty.
Returns
The EnrollmentGroup with the content of the enrollmentGroup in the Provisioning Device Service.
Exceptions
if the Provisioning Device Service was not able to retrieve the enrollmentGroup information for the provided enrollmentGroupId.
Remarks
This method will return the enrollmentGroup information for the provided enrollmentGroupId. It will retrieve the correspondent enrollmentGroup from the Device Provisioning Service, and return it in the EnrollmentGroup object.
If the enrollmentGroupId does not exists, this method will throw ProvisioningServiceClientException.
Applies to
GetEnrollmentGroupAsync(String, CancellationToken)
Retrieve the enrollmentGroup information.
public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup> GetEnrollmentGroupAsync (string enrollmentGroupId, System.Threading.CancellationToken cancellationToken);member this.GetEnrollmentGroupAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup>Public Function GetEnrollmentGroupAsync (enrollmentGroupId As String, cancellationToken As CancellationToken) As Task(Of EnrollmentGroup)Parameters
- enrollmentGroupId
- String
the string that identifies the enrollmentGroup. It cannot be null or empty.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
The EnrollmentGroup with the content of the enrollmentGroup in the Provisioning Device Service.
Exceptions
if the Provisioning Device Service was not able to retrieve the enrollmentGroup information for the provided enrollmentGroupId.
Remarks
This method will return the enrollmentGroup information for the provided enrollmentGroupId. It will retrieve the correspondent enrollmentGroup from the Device Provisioning Service, and return it in the EnrollmentGroup object.
If the enrollmentGroupId does not exists, this method will throw ProvisioningServiceClientException.
Applies to
Azure SDK for .NET