DeviceRegistrationStatesClient.CreateEnrollmentGroupQuery 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.

Creates a query that lists the registration states of devices in a given enrollment group.

public Microsoft.Azure.Devices.Provisioning.Service.Query CreateEnrollmentGroupQuery (string query, string enrollmentGroupId, int pageSize = 0, System.Threading.CancellationToken cancellationToken = default);

member this.CreateEnrollmentGroupQuery : string * string * int * System.Threading.CancellationToken -> Microsoft.Azure.Devices.Provisioning.Service.Query

Public Function CreateEnrollmentGroupQuery (query As String, enrollmentGroupId As String, Optional pageSize As Integer = 0, Optional cancellationToken As CancellationToken = Nothing) As Query

Parameters

query: String

The SQL query.

enrollmentGroupId: String

The enrollment group Id to query.

pageSize: Int32

The int with the maximum number of items per iteration. It can be 0 for default, but not negative.

cancellationToken: CancellationToken

The cancellation token.

Returns

Query

The iterable set of query results.

Exceptions

ArgumentNullException

If the provided query is null.

ArgumentException

If the provided query is empty or white space.

ArgumentOutOfRangeException

If the provided pageSize value is less than zero.

OperationCanceledException

If the provided cancellationToken has requested cancellation.

Applies to

Share via