ProvisioningServiceClient.CreateEnrollmentGroupQuery 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
CreateEnrollmentGroupQuery(QuerySpecification) |
Factory to create an enrollmentGroup query. |
CreateEnrollmentGroupQuery(QuerySpecification, HttpTransportSettings) |
Factory to create an enrollmentGroup query. |
CreateEnrollmentGroupQuery(QuerySpecification, Int32) |
Factory to create an enrollmentGroup query. |
CreateEnrollmentGroupQuery(QuerySpecification, CancellationToken) |
Factory to create an enrollmentGroup query. |
CreateEnrollmentGroupQuery(QuerySpecification, Int32, HttpTransportSettings) |
Factory to create an enrollmentGroup query. |
CreateEnrollmentGroupQuery(QuerySpecification, Int32, CancellationToken) |
Factory to create an enrollmentGroup query. |
CreateEnrollmentGroupQuery(QuerySpecification)
Factory to create an enrollmentGroup query.
public Microsoft.Azure.Devices.Provisioning.Service.Query CreateEnrollmentGroupQuery (Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification querySpecification);
member this.CreateEnrollmentGroupQuery : Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification -> Microsoft.Azure.Devices.Provisioning.Service.Query
Public Function CreateEnrollmentGroupQuery (querySpecification As QuerySpecification) As Query
Parameters
- querySpecification
- QuerySpecification
the QuerySpecification with the SQL query. It cannot be null
.
Returns
The Query iterator.
Exceptions
if the provided parameter is not correct.
Remarks
This method will create a new enrollment group query on 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
CreateEnrollmentGroupQuery(QuerySpecification, HttpTransportSettings)
Factory to create an enrollmentGroup query.
public Microsoft.Azure.Devices.Provisioning.Service.Query CreateEnrollmentGroupQuery (Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification querySpecification, Microsoft.Azure.Devices.Provisioning.Service.HttpTransportSettings httpTransportSettings);
member this.CreateEnrollmentGroupQuery : Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification * Microsoft.Azure.Devices.Provisioning.Service.HttpTransportSettings -> Microsoft.Azure.Devices.Provisioning.Service.Query
Public Function CreateEnrollmentGroupQuery (querySpecification As QuerySpecification, httpTransportSettings As HttpTransportSettings) As Query
Parameters
- querySpecification
- QuerySpecification
the QuerySpecification with the SQL query. It cannot be null
.
- httpTransportSettings
- HttpTransportSettings
Specifies the HTTP transport settings
Returns
The Query iterator.
Exceptions
if the provided parameter is not correct.
Remarks
This method will create a new enrollment group query on 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
CreateEnrollmentGroupQuery(QuerySpecification, Int32)
Factory to create an enrollmentGroup query.
public Microsoft.Azure.Devices.Provisioning.Service.Query CreateEnrollmentGroupQuery (Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification querySpecification, int pageSize);
member this.CreateEnrollmentGroupQuery : Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification * int -> Microsoft.Azure.Devices.Provisioning.Service.Query
Public Function CreateEnrollmentGroupQuery (querySpecification As QuerySpecification, pageSize As Integer) As Query
Parameters
- querySpecification
- QuerySpecification
the QuerySpecification with the SQL query. It cannot be null
.
- 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 enrollment group query on 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 CreateEnrollmentGroupQuery(QuerySpecification).
Applies to
CreateEnrollmentGroupQuery(QuerySpecification, CancellationToken)
Factory to create an enrollmentGroup query.
public Microsoft.Azure.Devices.Provisioning.Service.Query CreateEnrollmentGroupQuery (Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification querySpecification, System.Threading.CancellationToken cancellationToken);
member this.CreateEnrollmentGroupQuery : Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification * System.Threading.CancellationToken -> Microsoft.Azure.Devices.Provisioning.Service.Query
Public Function CreateEnrollmentGroupQuery (querySpecification As QuerySpecification, cancellationToken As CancellationToken) As Query
Parameters
- querySpecification
- QuerySpecification
the QuerySpecification with the SQL query. It cannot be null
.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
The Query iterator.
Exceptions
if the provided parameter is not correct.
Remarks
This method will create a new enrollment group query on 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
CreateEnrollmentGroupQuery(QuerySpecification, Int32, HttpTransportSettings)
Factory to create an enrollmentGroup query.
public Microsoft.Azure.Devices.Provisioning.Service.Query CreateEnrollmentGroupQuery (Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification querySpecification, int pageSize, Microsoft.Azure.Devices.Provisioning.Service.HttpTransportSettings httpTransportSettings);
member this.CreateEnrollmentGroupQuery : Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification * int * Microsoft.Azure.Devices.Provisioning.Service.HttpTransportSettings -> Microsoft.Azure.Devices.Provisioning.Service.Query
Public Function CreateEnrollmentGroupQuery (querySpecification As QuerySpecification, pageSize As Integer, httpTransportSettings As HttpTransportSettings) As Query
Parameters
- querySpecification
- QuerySpecification
the QuerySpecification with the SQL query. It cannot be null
.
- 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 enrollment group query on 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 CreateEnrollmentGroupQuery(QuerySpecification).
Applies to
CreateEnrollmentGroupQuery(QuerySpecification, Int32, CancellationToken)
Factory to create an enrollmentGroup query.
public Microsoft.Azure.Devices.Provisioning.Service.Query CreateEnrollmentGroupQuery (Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification querySpecification, int pageSize, System.Threading.CancellationToken cancellationToken);
member this.CreateEnrollmentGroupQuery : Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification * int * System.Threading.CancellationToken -> Microsoft.Azure.Devices.Provisioning.Service.Query
Public Function CreateEnrollmentGroupQuery (querySpecification As QuerySpecification, pageSize As Integer, cancellationToken As CancellationToken) As Query
Parameters
- querySpecification
- QuerySpecification
the QuerySpecification with the SQL query. It cannot be null
.
- 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 enrollment group query on 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 CreateEnrollmentGroupQuery(QuerySpecification).
Applies to
Azure SDK for .NET