Share via


ProvisioningServiceClient.CreateEnrollmentGroupRegistrationStateQuery Method

Definition

Overloads

CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String)

Factory to create a registration status query.

CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String, HttpTransportSettings)

Factory to create a registration status query.

CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String, Int32)

Factory to create a registration status query.

CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String, CancellationToken)

Factory to create a registration status query.

CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String, Int32, HttpTransportSettings)

Factory to create a registration status query.

CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String, Int32, CancellationToken)

Factory to create a registration status query.

CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String)

Factory to create a registration status query.

public Microsoft.Azure.Devices.Provisioning.Service.Query CreateEnrollmentGroupRegistrationStateQuery (Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification querySpecification, string enrollmentGroupId);
member this.CreateEnrollmentGroupRegistrationStateQuery : Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification * string -> Microsoft.Azure.Devices.Provisioning.Service.Query
Public Function CreateEnrollmentGroupRegistrationStateQuery (querySpecification As QuerySpecification, enrollmentGroupId As String) As Query

Parameters

querySpecification
QuerySpecification

the QuerySpecification with the SQL query. It cannot be null.

enrollmentGroupId
String

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

Returns

The Query iterator.

Remarks

This method will create a new registration status query for a specific enrollment group on the Device Provisioning Service and return it as a Query iterator.

The Device Provisioning Service expects a SQL query in the QuerySpecification, for instance "SELECT * FROM enrollments".

Applies to

CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String, HttpTransportSettings)

Factory to create a registration status query.

public Microsoft.Azure.Devices.Provisioning.Service.Query CreateEnrollmentGroupRegistrationStateQuery (Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification querySpecification, string enrollmentGroupId, Microsoft.Azure.Devices.Provisioning.Service.HttpTransportSettings httpTransportSettings);
member this.CreateEnrollmentGroupRegistrationStateQuery : Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification * string * Microsoft.Azure.Devices.Provisioning.Service.HttpTransportSettings -> Microsoft.Azure.Devices.Provisioning.Service.Query
Public Function CreateEnrollmentGroupRegistrationStateQuery (querySpecification As QuerySpecification, enrollmentGroupId As String, httpTransportSettings As HttpTransportSettings) As Query

Parameters

querySpecification
QuerySpecification

the QuerySpecification with the SQL query. It cannot be null.

enrollmentGroupId
String

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

httpTransportSettings
HttpTransportSettings

Specifies the HTTP transport settings

Returns

The Query iterator.

Remarks

This method will create a new registration status query for a specific enrollment group on the Device Provisioning Service and return it as a Query iterator.

The Device Provisioning Service expects a SQL query in the QuerySpecification, for instance "SELECT * FROM enrollments".

Applies to

CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String, Int32)

Factory to create a registration status query.

public Microsoft.Azure.Devices.Provisioning.Service.Query CreateEnrollmentGroupRegistrationStateQuery (Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification querySpecification, string enrollmentGroupId, int pageSize);
member this.CreateEnrollmentGroupRegistrationStateQuery : Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification * string * int -> Microsoft.Azure.Devices.Provisioning.Service.Query
Public Function CreateEnrollmentGroupRegistrationStateQuery (querySpecification As QuerySpecification, enrollmentGroupId As String, pageSize As Integer) As Query

Parameters

querySpecification
QuerySpecification

the QuerySpecification with the SQL query. It cannot be null.

enrollmentGroupId
String

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

pageSize
Int32

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

Returns

The Query iterator.

Exceptions

if the provided parameters are not correct.

Remarks

This method will create a new registration status query for a specific enrollment group on the Device Provisioning Service and return it as a Query iterator.

The Device Provisioning Service expects a SQL query in the QuerySpecification, for instance "SELECT * FROM enrollments".

For each iteration, the Query will return a List of objects correspondent to the query result. The maximum number of items per iteration can be specified by the pageSize. It is optional, you can provide 0 for default pageSize or use the API CreateIndividualEnrollmentQuery(QuerySpecification).

Applies to

CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String, CancellationToken)

Factory to create a registration status query.

public Microsoft.Azure.Devices.Provisioning.Service.Query CreateEnrollmentGroupRegistrationStateQuery (Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification querySpecification, string enrollmentGroupId, System.Threading.CancellationToken cancellationToken);
member this.CreateEnrollmentGroupRegistrationStateQuery : Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification * string * System.Threading.CancellationToken -> Microsoft.Azure.Devices.Provisioning.Service.Query
Public Function CreateEnrollmentGroupRegistrationStateQuery (querySpecification As QuerySpecification, enrollmentGroupId As String, cancellationToken As CancellationToken) As Query

Parameters

querySpecification
QuerySpecification

the QuerySpecification with the SQL query. It cannot be null.

enrollmentGroupId
String

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

cancellationToken
CancellationToken

The cancellation token.

Returns

The Query iterator.

Remarks

This method will create a new registration status query for a specific enrollment group on the Device Provisioning Service and return it as a Query iterator.

The Device Provisioning Service expects a SQL query in the QuerySpecification, for instance "SELECT * FROM enrollments".

Applies to

CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String, Int32, HttpTransportSettings)

Factory to create a registration status query.

public Microsoft.Azure.Devices.Provisioning.Service.Query CreateEnrollmentGroupRegistrationStateQuery (Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification querySpecification, string enrollmentGroupId, int pageSize, Microsoft.Azure.Devices.Provisioning.Service.HttpTransportSettings httpTransportSettings);
member this.CreateEnrollmentGroupRegistrationStateQuery : Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification * string * int * Microsoft.Azure.Devices.Provisioning.Service.HttpTransportSettings -> Microsoft.Azure.Devices.Provisioning.Service.Query
Public Function CreateEnrollmentGroupRegistrationStateQuery (querySpecification As QuerySpecification, enrollmentGroupId As String, pageSize As Integer, httpTransportSettings As HttpTransportSettings) As Query

Parameters

querySpecification
QuerySpecification

the QuerySpecification with the SQL query. It cannot be null.

enrollmentGroupId
String

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

pageSize
Int32

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

httpTransportSettings
HttpTransportSettings

Specifies the HTTP transport settings

Returns

The Query iterator.

Exceptions

if the provided parameters are not correct.

Remarks

This method will create a new registration status query for a specific enrollment group on the Device Provisioning Service and return it as a Query iterator.

The Device Provisioning Service expects a SQL query in the QuerySpecification, for instance "SELECT * FROM enrollments".

For each iteration, the Query will return a List of objects correspondent to the query result. The maximum number of items per iteration can be specified by the pageSize. It is optional, you can provide 0 for default pageSize or use the API CreateIndividualEnrollmentQuery(QuerySpecification).

Applies to

CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String, Int32, CancellationToken)

Factory to create a registration status query.

public Microsoft.Azure.Devices.Provisioning.Service.Query CreateEnrollmentGroupRegistrationStateQuery (Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification querySpecification, string enrollmentGroupId, int pageSize, System.Threading.CancellationToken cancellationToken);
member this.CreateEnrollmentGroupRegistrationStateQuery : Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification * string * int * System.Threading.CancellationToken -> Microsoft.Azure.Devices.Provisioning.Service.Query
Public Function CreateEnrollmentGroupRegistrationStateQuery (querySpecification As QuerySpecification, enrollmentGroupId As String, pageSize As Integer, cancellationToken As CancellationToken) As Query

Parameters

querySpecification
QuerySpecification

the QuerySpecification with the SQL query. It cannot be null.

enrollmentGroupId
String

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

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

The Query iterator.

Exceptions

if the provided parameters are not correct.

Remarks

This method will create a new registration status query for a specific enrollment group on the Device Provisioning Service and return it as a Query iterator.

The Device Provisioning Service expects a SQL query in the QuerySpecification, for instance "SELECT * FROM enrollments".

For each iteration, the Query will return a List of objects correspondent to the query result. The maximum number of items per iteration can be specified by the pageSize. It is optional, you can provide 0 for default pageSize or use the API CreateIndividualEnrollmentQuery(QuerySpecification).

Applies to