ProvisioningServiceClient Class

  • Reference

Definition

Namespace:
Microsoft.Azure.Devices.Provisioning.Service
Assembly:
Microsoft.Azure.Devices.Provisioning.Service.dll
Package:
Microsoft.Azure.Devices.Provisioning.Service v1.18.1
Package:
Microsoft.Azure.Devices.Provisioning.Service v2.0.0-preview002

Device Provisioning Service Client.

public class ProvisioningServiceClient : IDisposable
type ProvisioningServiceClient = class
    interface IDisposable
Public Class ProvisioningServiceClient
Implements IDisposable
Inheritance
Object
ProvisioningServiceClient
Implements
IDisposable

Remarks

The IoT hub Device Provisioning Service is a helper service for IoT hub that enables automatic device provisioning to a specified IoT hub without requiring human intervention. You can use the Device Provisioning Service to provision millions of devices in a secure and scalable manner.

Constructors

ProvisioningServiceClient(String, ProvisioningServiceClientOptions)

Create a new instance of this client.

Properties

DeviceRegistrationStates

Subclient of ProvisioningServiceClient that handles all device registration state operations including getting a device registration state, deleting a device registration state, and querying device registration states.
EnrollmentGroups

Subclient of ProvisioningServiceClient that handles all enrollment group operations including getting/creating/setting/deleting enrollment groups, querying enrollment groups, and getting attestation mechanisms for particular enrollment groups.
IndividualEnrollments

Subclient of ProvisioningServiceClient that handles all individual enrollment operations including getting/creating/setting/deleting individual enrollments, querying individual enrollments, and getting attestation mechanisms for particular individual enrollments.

Methods

CreateEnrollmentGroupQuery(QuerySpecification)

Factory to create an enrollmentGroup query.
CreateEnrollmentGroupQuery(QuerySpecification, CancellationToken)

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, Int32, CancellationToken)

Factory to create an enrollmentGroup query.
CreateEnrollmentGroupQuery(QuerySpecification, Int32, HttpTransportSettings)

Factory to create an enrollmentGroup query.
CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String)

Factory to create a registration status query.
CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String, CancellationToken)

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, Int32, CancellationToken)

Factory to create a registration status query.
CreateEnrollmentGroupRegistrationStateQuery(QuerySpecification, String, Int32, HttpTransportSettings)

Factory to create a registration status query.
CreateFromConnectionString(String)

Create a new instance of the ProvisioningServiceClient that exposes the API to the Device Provisioning Service.
CreateFromConnectionString(String, HttpTransportSettings)

Create a new instance of the ProvisioningServiceClient that exposes the API to the Device Provisioning Service.
CreateIndividualEnrollmentQuery(QuerySpecification)

Factory to create a individualEnrollment query.
CreateIndividualEnrollmentQuery(QuerySpecification, CancellationToken)

Factory to create a individualEnrollment query.
CreateIndividualEnrollmentQuery(QuerySpecification, HttpTransportSettings)

Factory to create a individualEnrollment query.
CreateIndividualEnrollmentQuery(QuerySpecification, Int32)

Factory to create a individualEnrollment query.
CreateIndividualEnrollmentQuery(QuerySpecification, Int32, CancellationToken)

Factory to create a individualEnrollment query.
CreateIndividualEnrollmentQuery(QuerySpecification, Int32, HttpTransportSettings)

Factory to create a individualEnrollment query.
CreateOrUpdateEnrollmentGroupAsync(EnrollmentGroup)

Create or update an enrollment group record.
CreateOrUpdateEnrollmentGroupAsync(EnrollmentGroup, CancellationToken)

Create or update an enrollment group record.
CreateOrUpdateIndividualEnrollmentAsync(IndividualEnrollment)

Create or update a individual Device Enrollment record.
CreateOrUpdateIndividualEnrollmentAsync(IndividualEnrollment, CancellationToken)

Creates or updates an individual enrollment.
DeleteDeviceRegistrationStateAsync(DeviceRegistrationState)

Delete the registration status information.
DeleteDeviceRegistrationStateAsync(DeviceRegistrationState, CancellationToken)

Delete the registration status information.
DeleteDeviceRegistrationStateAsync(String)

Delete the registration status information.
DeleteDeviceRegistrationStateAsync(String, CancellationToken)

Delete the registration status information.
DeleteDeviceRegistrationStateAsync(String, String)

Delete the registration status information.
DeleteDeviceRegistrationStateAsync(String, String, CancellationToken)

Delete the registration status information.
DeleteEnrollmentGroupAsync(EnrollmentGroup)

Delete the enrollmentGroup information.
DeleteEnrollmentGroupAsync(EnrollmentGroup, CancellationToken)

Delete the enrollmentGroup information.
DeleteEnrollmentGroupAsync(String)

Delete the enrollmentGroup information.
DeleteEnrollmentGroupAsync(String, CancellationToken)

Delete the enrollmentGroup information.
DeleteEnrollmentGroupAsync(String, String)

Delete the enrollmentGroup information.
DeleteEnrollmentGroupAsync(String, String, CancellationToken)

Delete the enrollmentGroup information.
DeleteIndividualEnrollmentAsync(IndividualEnrollment)

Delete the individualEnrollment information.
DeleteIndividualEnrollmentAsync(IndividualEnrollment, CancellationToken)

Deletes an individual enrollment.
DeleteIndividualEnrollmentAsync(String)

Delete the individualEnrollment information.
DeleteIndividualEnrollmentAsync(String, CancellationToken)

Delete the individualEnrollment information.
DeleteIndividualEnrollmentAsync(String, String)

Delete the individualEnrollment information.
DeleteIndividualEnrollmentAsync(String, String, CancellationToken)

Deletes an individual enrollment if the eTag matches.
Dispose()

Dispose the Provisioning Service Client and its dependencies.
Dispose(Boolean)

Releases the unmanaged resources used by the Component and optionally releases the managed resources.
GetDeviceRegistrationStateAsync(String)

Retrieve the registration status information.
GetDeviceRegistrationStateAsync(String, CancellationToken)

Retrieve the registration status information.
GetEnrollmentGroupAsync(String)

Retrieve the enrollmentGroup information.
GetEnrollmentGroupAsync(String, CancellationToken)

Retrieve the enrollmentGroup information.
GetEnrollmentGroupAttestationAsync(String, CancellationToken)

Retrieve the enrollmentGroup attestation information.
GetIndividualEnrollmentAsync(String)

Retrieve the individualEnrollment information.
GetIndividualEnrollmentAsync(String, CancellationToken)

Gets the individual enrollment object.
GetIndividualEnrollmentAttestationAsync(String, CancellationToken)

Retrieve the attestation information for an individual enrollment.
RunBulkEnrollmentOperationAsync(BulkOperationMode, IEnumerable<IndividualEnrollment>)

Create, update or delete a set of individual Device Enrollments.
RunBulkEnrollmentOperationAsync(BulkOperationMode, IEnumerable<IndividualEnrollment>, CancellationToken)

Create, update or delete a set of individual Device Enrollments.

Applies to