azure-iot-provisioning-service package

Classes

ProvisioningServiceClient
Query

Interfaces

AttestationMechanism

Device attestation method.

BulkEnrollmentOperation

Bulk operation

BulkEnrollmentOperationError

Bulk enrollment operation error

BulkEnrollmentOperationResult

Bulk operation result

CustomAllocationDefinition

Custom allocation definition.

DeviceCapabilities

Capabilities of the device that will be provisioned using this enrollment record.

DeviceRegistrationState

Device registration status.

EnrollmentGroup

The enrollment group object.

IndividualEnrollment

The individual enrollment record.

InitialTwin

Device twin state.

Metadata
ReprovisionPolicy

The behavior the service should adopt when a device is re-provisioned to another IoT Hub.

SymmetricKeyAttestation

Attestation via Symmetric Key.

TpmAttestation

Attestation via TPM.

TwinCollection
X509Attestation

Attestation via X509.

X509CAReferences
X509CertificateInfo

X509 certificate info. This object is not provided by the application. It is populated by the service from a provided certificate.

X509CertificateWithInfo

Certificate and Certificate info

X509Certificates

Primary and secondary certificates

QueryResult

The query result.

QuerySpecification

A Json query request

Type Aliases

AllocationPolicyType

The allocation policy of this individual enrollment. This policy overrides the tenant-level allocation policy.

  • 'hashed': Linked IoT hubs are equally likely to have devices provisioned to them.
  • 'geoLatency': Devices are provisioned to an IoT hub with the lowest latency to the device.If multiple linked IoT hubs would provide the same lowest latency, the provisioning service hashes devices across those hubs.
  • 'static' : Specification of the desired IoT hub in the enrollment list takes priority over the service-level allocation policy.
  • 'custom': Devices are provisioned to an IoT hub based on your own custom logic. The provisioning service passes information about the device to the logic, and the logic returns the desired IoT hub as well as the desired initial configuration. We recommend using Azure Functions to host your logic.
AttestationTypes
BulkOperationMode

The kind of operations that can be performed with a BulkOperation. Only one kind of operation may be performed on any instance of a BulkOperation.

ProvisioningStatus
RegistrationStatus

The provisioning state of the device at the moment of the request.

RegistrationSubstatus

Substatus for 'Assigned' devices. Possible values include:

  • 'initialAssignment': Device has been assigned to an IoT hub for the first time.
  • 'deviceDataMigrated': Device has been assigned to a different IoT hub and its device data was migrated from the previously assigned IoT hub. Device data was removed from the previously assigned IoT hub.
  • 'deviceDataReset': Device has been assigned to a different IoT hub and its device data was populated from the initial state stored in the enrollment. Device data was removed from the previously assigned IoT hub.
QueryCallback