ProvisioningServiceClient (stable:2021-10-01)

2025/08/29 • 15 new methods

IndividualEnrollment_Get (new)
Description :  Get a device enrollment record.
Reference :  Link ¶

⚼ Request

GET:  /enrollments/{id}
{
id:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
registrationId:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: True ,
}
string ,
deviceId:
{
Description: Desired IoT Hub device ID (optional). ,
Required: False ,
}
string ,
registrationState:
{
Description: Current registration status. ,
Required: False ,
}
{
registrationId:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: False ,
}
string ,
createdDateTimeUtc:
{
Description: Registration create date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
assignedHub:
{
Description: Assigned Azure IoT Hub. ,
Required: False ,
}
string ,
deviceId:
{
Description: Device ID. ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status. ,
Enum:
{
unassigned: No description available. ,
assigning: No description available. ,
assigned: No description available. ,
failed: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
substatus:
{
Description: 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, 'reprovisionedToInitialAssignment': Device has been re-provisioned to a previously assigned IoT hub. ,
Enum:
{
initialAssignment: No description available. ,
deviceDataMigrated: No description available. ,
deviceDataReset: No description available. ,
reprovisionedToInitialAssignment: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: Last updated date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
payload:
{
Description: Custom allocation payload returned from the webhook to the device. ,
Required: False ,
}
object ,
}
,
optionalDeviceInformation:
{
Description: Optional Device Information. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
attestation:
{
Description: Attestation method used by the device. ,
Required: True ,
}
{
type:
{
Description: Attestation Type. ,
Enum:
{
none: No description available. ,
tpm: No description available. ,
x509: No description available. ,
symmetricKey: No description available. ,
}
,
Required: True ,
}
enum ,
tpm:
{
Description: TPM attestation method. ,
Required: False ,
}
{
endorsementKey:
{
Required: True ,
}
string ,
storageRootKey:
{
Required: False ,
}
string ,
}
,
x509:
{
Description: X509 attestation method. ,
Required: False ,
}
{
clientCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
signingCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
caReferences:
{
Description: Primary and secondary CA references. ,
Required: False ,
}
{
primary:
{
Required: False ,
}
string ,
secondary:
{
Required: False ,
}
string ,
}
,
}
,
symmetricKey:
{
Description: Symmetric Key attestation method. ,
Required: False ,
}
{
primaryKey:
{
Description: Primary symmetric key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary symmetric key. ,
Required: False ,
}
string ,
}
,
}
,
capabilities:
{
Description: Capabilities of the device. ,
Required: False ,
}
{
iotEdge:
{
Description: If set to true, this device is an IoTEdge device. ,
Required: True ,
}
boolean ,
}
,
iotHubHostName:
{
Description: The Iot Hub host name. ,
Required: False ,
}
string ,
initialTwin:
{
Description: Initial device twin. ,
Required: False ,
}
{
tags:
{
Description: Twin tags. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
properties:
{
Description: Twin desired properties. ,
Required: False ,
}
{
desired:
{
Description: Gets and sets the InitialTwin desired properties. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: The provisioning status. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reprovisionPolicy:
{
Description: The behavior when a device is re-provisioned to an IoT hub. ,
Required: False ,
}
{
updateHubAssignment:
{
Description: When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub. ,
Required: True ,
}
boolean ,
migrateDeviceData:
{
Description: When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the corresponding enrollment list. ,
Required: True ,
}
boolean ,
}
,
createdDateTimeUtc:
{
Description: The DateTime this resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: The DateTime this resource was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
allocationPolicy:
{
Description: The allocation policy of this resource. This policy overrides the tenant level allocation policy for this individual enrollment or enrollment group. Possible values include '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. ,
Enum:
{
hashed: No description available. ,
geoLatency: No description available. ,
static: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
iotHubs:
{
Description: The list of IoT Hub hostnames the device(s) in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs. ,
Required: False ,
}
[
string ,
]
,
customAllocationDefinition:
{
Description: This tells DPS which webhook to call when using custom allocation. ,
Required: False ,
}
{
webhookUrl:
{
Description: The webhook URL used for allocation requests. ,
Required: True ,
}
string ,
apiVersion:
{
Description: The API version of the provisioning service types (such as IndividualEnrollment) sent in the custom allocation request. Minimum supported version: "2018-09-01-preview". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
IndividualEnrollment_CreateOrUpdate (new)
Description :  Create or update a device enrollment record.
Reference :  Link ¶

⚼ Request

PUT:  /enrollments/{id}
{
id:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: True ,
}
string ,
enrollment:
{
Description: The device enrollment record. ,
Required: True ,
}
{
registrationId:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: True ,
}
string ,
deviceId:
{
Description: Desired IoT Hub device ID (optional). ,
Required: False ,
}
string ,
registrationState:
{
Description: Current registration status. ,
Required: False ,
}
{
registrationId:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: False ,
}
string ,
createdDateTimeUtc:
{
Description: Registration create date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
assignedHub:
{
Description: Assigned Azure IoT Hub. ,
Required: False ,
}
string ,
deviceId:
{
Description: Device ID. ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status. ,
Enum:
{
unassigned: No description available. ,
assigning: No description available. ,
assigned: No description available. ,
failed: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
substatus:
{
Description: 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, 'reprovisionedToInitialAssignment': Device has been re-provisioned to a previously assigned IoT hub. ,
Enum:
{
initialAssignment: No description available. ,
deviceDataMigrated: No description available. ,
deviceDataReset: No description available. ,
reprovisionedToInitialAssignment: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: Last updated date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
payload:
{
Description: Custom allocation payload returned from the webhook to the device. ,
Required: False ,
}
object ,
}
,
optionalDeviceInformation:
{
Description: Optional Device Information. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
attestation:
{
Description: Attestation method used by the device. ,
Required: True ,
}
{
type:
{
Description: Attestation Type. ,
Enum:
{
none: No description available. ,
tpm: No description available. ,
x509: No description available. ,
symmetricKey: No description available. ,
}
,
Required: True ,
}
enum ,
tpm:
{
Description: TPM attestation method. ,
Required: False ,
}
{
endorsementKey:
{
Required: True ,
}
string ,
storageRootKey:
{
Required: False ,
}
string ,
}
,
x509:
{
Description: X509 attestation method. ,
Required: False ,
}
{
clientCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
signingCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
caReferences:
{
Description: Primary and secondary CA references. ,
Required: False ,
}
{
primary:
{
Required: False ,
}
string ,
secondary:
{
Required: False ,
}
string ,
}
,
}
,
symmetricKey:
{
Description: Symmetric Key attestation method. ,
Required: False ,
}
{
primaryKey:
{
Description: Primary symmetric key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary symmetric key. ,
Required: False ,
}
string ,
}
,
}
,
capabilities:
{
Description: Capabilities of the device. ,
Required: False ,
}
{
iotEdge:
{
Description: If set to true, this device is an IoTEdge device. ,
Required: True ,
}
boolean ,
}
,
iotHubHostName:
{
Description: The Iot Hub host name. ,
Required: False ,
}
string ,
initialTwin:
{
Description: Initial device twin. ,
Required: False ,
}
{
tags:
{
Description: Twin tags. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
properties:
{
Description: Twin desired properties. ,
Required: False ,
}
{
desired:
{
Description: Gets and sets the InitialTwin desired properties. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: The provisioning status. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reprovisionPolicy:
{
Description: The behavior when a device is re-provisioned to an IoT hub. ,
Required: False ,
}
{
updateHubAssignment:
{
Description: When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub. ,
Required: True ,
}
boolean ,
migrateDeviceData:
{
Description: When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the corresponding enrollment list. ,
Required: True ,
}
boolean ,
}
,
createdDateTimeUtc:
{
Description: The DateTime this resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: The DateTime this resource was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
allocationPolicy:
{
Description: The allocation policy of this resource. This policy overrides the tenant level allocation policy for this individual enrollment or enrollment group. Possible values include '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. ,
Enum:
{
hashed: No description available. ,
geoLatency: No description available. ,
static: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
iotHubs:
{
Description: The list of IoT Hub hostnames the device(s) in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs. ,
Required: False ,
}
[
string ,
]
,
customAllocationDefinition:
{
Description: This tells DPS which webhook to call when using custom allocation. ,
Required: False ,
}
{
webhookUrl:
{
Description: The webhook URL used for allocation requests. ,
Required: True ,
}
string ,
apiVersion:
{
Description: The API version of the provisioning service types (such as IndividualEnrollment) sent in the custom allocation request. Minimum supported version: "2018-09-01-preview". ,
Required: True ,
}
string ,
}
,
}
,
If-Match:
{
Description: The ETag of the enrollment record. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
registrationId:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: True ,
}
string ,
deviceId:
{
Description: Desired IoT Hub device ID (optional). ,
Required: False ,
}
string ,
registrationState:
{
Description: Current registration status. ,
Required: False ,
}
{
registrationId:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: False ,
}
string ,
createdDateTimeUtc:
{
Description: Registration create date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
assignedHub:
{
Description: Assigned Azure IoT Hub. ,
Required: False ,
}
string ,
deviceId:
{
Description: Device ID. ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status. ,
Enum:
{
unassigned: No description available. ,
assigning: No description available. ,
assigned: No description available. ,
failed: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
substatus:
{
Description: 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, 'reprovisionedToInitialAssignment': Device has been re-provisioned to a previously assigned IoT hub. ,
Enum:
{
initialAssignment: No description available. ,
deviceDataMigrated: No description available. ,
deviceDataReset: No description available. ,
reprovisionedToInitialAssignment: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: Last updated date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
payload:
{
Description: Custom allocation payload returned from the webhook to the device. ,
Required: False ,
}
object ,
}
,
optionalDeviceInformation:
{
Description: Optional Device Information. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
attestation:
{
Description: Attestation method used by the device. ,
Required: True ,
}
{
type:
{
Description: Attestation Type. ,
Enum:
{
none: No description available. ,
tpm: No description available. ,
x509: No description available. ,
symmetricKey: No description available. ,
}
,
Required: True ,
}
enum ,
tpm:
{
Description: TPM attestation method. ,
Required: False ,
}
{
endorsementKey:
{
Required: True ,
}
string ,
storageRootKey:
{
Required: False ,
}
string ,
}
,
x509:
{
Description: X509 attestation method. ,
Required: False ,
}
{
clientCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
signingCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
caReferences:
{
Description: Primary and secondary CA references. ,
Required: False ,
}
{
primary:
{
Required: False ,
}
string ,
secondary:
{
Required: False ,
}
string ,
}
,
}
,
symmetricKey:
{
Description: Symmetric Key attestation method. ,
Required: False ,
}
{
primaryKey:
{
Description: Primary symmetric key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary symmetric key. ,
Required: False ,
}
string ,
}
,
}
,
capabilities:
{
Description: Capabilities of the device. ,
Required: False ,
}
{
iotEdge:
{
Description: If set to true, this device is an IoTEdge device. ,
Required: True ,
}
boolean ,
}
,
iotHubHostName:
{
Description: The Iot Hub host name. ,
Required: False ,
}
string ,
initialTwin:
{
Description: Initial device twin. ,
Required: False ,
}
{
tags:
{
Description: Twin tags. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
properties:
{
Description: Twin desired properties. ,
Required: False ,
}
{
desired:
{
Description: Gets and sets the InitialTwin desired properties. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: The provisioning status. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reprovisionPolicy:
{
Description: The behavior when a device is re-provisioned to an IoT hub. ,
Required: False ,
}
{
updateHubAssignment:
{
Description: When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub. ,
Required: True ,
}
boolean ,
migrateDeviceData:
{
Description: When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the corresponding enrollment list. ,
Required: True ,
}
boolean ,
}
,
createdDateTimeUtc:
{
Description: The DateTime this resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: The DateTime this resource was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
allocationPolicy:
{
Description: The allocation policy of this resource. This policy overrides the tenant level allocation policy for this individual enrollment or enrollment group. Possible values include '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. ,
Enum:
{
hashed: No description available. ,
geoLatency: No description available. ,
static: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
iotHubs:
{
Description: The list of IoT Hub hostnames the device(s) in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs. ,
Required: False ,
}
[
string ,
]
,
customAllocationDefinition:
{
Description: This tells DPS which webhook to call when using custom allocation. ,
Required: False ,
}
{
webhookUrl:
{
Description: The webhook URL used for allocation requests. ,
Required: True ,
}
string ,
apiVersion:
{
Description: The API version of the provisioning service types (such as IndividualEnrollment) sent in the custom allocation request. Minimum supported version: "2018-09-01-preview". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
IndividualEnrollment_Delete (new)
Description :  Delete a device enrollment record.
Reference :  Link ¶

⚼ Request

DELETE:  /enrollments/{id}
{
id:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: True ,
}
string ,
If-Match:
{
Description: The ETag of the enrollment record. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
EnrollmentGroup_Get (new)
Description :  Get a device enrollment group.
Reference :  Link ¶

⚼ Request

GET:  /enrollmentGroups/{id}
{
id:
{
Description: Enrollment group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enrollmentGroupId:
{
Description: Enrollment Group ID. ,
Required: True ,
}
string ,
attestation:
{
Description: Attestation method used by the device. ,
Required: True ,
}
{
type:
{
Description: Attestation Type. ,
Enum:
{
none: No description available. ,
tpm: No description available. ,
x509: No description available. ,
symmetricKey: No description available. ,
}
,
Required: True ,
}
enum ,
tpm:
{
Description: TPM attestation method. ,
Required: False ,
}
{
endorsementKey:
{
Required: True ,
}
string ,
storageRootKey:
{
Required: False ,
}
string ,
}
,
x509:
{
Description: X509 attestation method. ,
Required: False ,
}
{
clientCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
signingCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
caReferences:
{
Description: Primary and secondary CA references. ,
Required: False ,
}
{
primary:
{
Required: False ,
}
string ,
secondary:
{
Required: False ,
}
string ,
}
,
}
,
symmetricKey:
{
Description: Symmetric Key attestation method. ,
Required: False ,
}
{
primaryKey:
{
Description: Primary symmetric key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary symmetric key. ,
Required: False ,
}
string ,
}
,
}
,
capabilities:
{
Description: Capabilities of the device. ,
Required: False ,
}
{
iotEdge:
{
Description: If set to true, this device is an IoTEdge device. ,
Required: True ,
}
boolean ,
}
,
iotHubHostName:
{
Description: The Iot Hub host name. ,
Required: False ,
}
string ,
initialTwin:
{
Description: Initial device twin. ,
Required: False ,
}
{
tags:
{
Description: Twin tags. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
properties:
{
Description: Twin desired properties. ,
Required: False ,
}
{
desired:
{
Description: Gets and sets the InitialTwin desired properties. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: The provisioning status. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reprovisionPolicy:
{
Description: The behavior when a device is re-provisioned to an IoT hub. ,
Required: False ,
}
{
updateHubAssignment:
{
Description: When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub. ,
Required: True ,
}
boolean ,
migrateDeviceData:
{
Description: When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the corresponding enrollment list. ,
Required: True ,
}
boolean ,
}
,
createdDateTimeUtc:
{
Description: The DateTime this resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: The DateTime this resource was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
allocationPolicy:
{
Description: The allocation policy of this resource. This policy overrides the tenant level allocation policy for this individual enrollment or enrollment group. Possible values include '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. ,
Enum:
{
hashed: No description available. ,
geoLatency: No description available. ,
static: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
iotHubs:
{
Description: The list of IoT Hub hostnames the device(s) in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs. ,
Required: False ,
}
[
string ,
]
,
customAllocationDefinition:
{
Description: This tells DPS which webhook to call when using custom allocation. ,
Required: False ,
}
{
webhookUrl:
{
Description: The webhook URL used for allocation requests. ,
Required: True ,
}
string ,
apiVersion:
{
Description: The API version of the provisioning service types (such as IndividualEnrollment) sent in the custom allocation request. Minimum supported version: "2018-09-01-preview". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
EnrollmentGroup_CreateOrUpdate (new)
Description :  Create or update a device enrollment group.
Reference :  Link ¶

⚼ Request

PUT:  /enrollmentGroups/{id}
{
id:
{
Description: Enrollment group ID. ,
Required: True ,
}
string ,
enrollmentGroup:
{
Description: The device enrollment group. ,
Required: True ,
}
{
enrollmentGroupId:
{
Description: Enrollment Group ID. ,
Required: True ,
}
string ,
attestation:
{
Description: Attestation method used by the device. ,
Required: True ,
}
{
type:
{
Description: Attestation Type. ,
Enum:
{
none: No description available. ,
tpm: No description available. ,
x509: No description available. ,
symmetricKey: No description available. ,
}
,
Required: True ,
}
enum ,
tpm:
{
Description: TPM attestation method. ,
Required: False ,
}
{
endorsementKey:
{
Required: True ,
}
string ,
storageRootKey:
{
Required: False ,
}
string ,
}
,
x509:
{
Description: X509 attestation method. ,
Required: False ,
}
{
clientCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
signingCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
caReferences:
{
Description: Primary and secondary CA references. ,
Required: False ,
}
{
primary:
{
Required: False ,
}
string ,
secondary:
{
Required: False ,
}
string ,
}
,
}
,
symmetricKey:
{
Description: Symmetric Key attestation method. ,
Required: False ,
}
{
primaryKey:
{
Description: Primary symmetric key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary symmetric key. ,
Required: False ,
}
string ,
}
,
}
,
capabilities:
{
Description: Capabilities of the device. ,
Required: False ,
}
{
iotEdge:
{
Description: If set to true, this device is an IoTEdge device. ,
Required: True ,
}
boolean ,
}
,
iotHubHostName:
{
Description: The Iot Hub host name. ,
Required: False ,
}
string ,
initialTwin:
{
Description: Initial device twin. ,
Required: False ,
}
{
tags:
{
Description: Twin tags. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
properties:
{
Description: Twin desired properties. ,
Required: False ,
}
{
desired:
{
Description: Gets and sets the InitialTwin desired properties. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: The provisioning status. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reprovisionPolicy:
{
Description: The behavior when a device is re-provisioned to an IoT hub. ,
Required: False ,
}
{
updateHubAssignment:
{
Description: When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub. ,
Required: True ,
}
boolean ,
migrateDeviceData:
{
Description: When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the corresponding enrollment list. ,
Required: True ,
}
boolean ,
}
,
createdDateTimeUtc:
{
Description: The DateTime this resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: The DateTime this resource was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
allocationPolicy:
{
Description: The allocation policy of this resource. This policy overrides the tenant level allocation policy for this individual enrollment or enrollment group. Possible values include '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. ,
Enum:
{
hashed: No description available. ,
geoLatency: No description available. ,
static: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
iotHubs:
{
Description: The list of IoT Hub hostnames the device(s) in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs. ,
Required: False ,
}
[
string ,
]
,
customAllocationDefinition:
{
Description: This tells DPS which webhook to call when using custom allocation. ,
Required: False ,
}
{
webhookUrl:
{
Description: The webhook URL used for allocation requests. ,
Required: True ,
}
string ,
apiVersion:
{
Description: The API version of the provisioning service types (such as IndividualEnrollment) sent in the custom allocation request. Minimum supported version: "2018-09-01-preview". ,
Required: True ,
}
string ,
}
,
}
,
If-Match:
{
Description: The ETag of the enrollment record. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
enrollmentGroupId:
{
Description: Enrollment Group ID. ,
Required: True ,
}
string ,
attestation:
{
Description: Attestation method used by the device. ,
Required: True ,
}
{
type:
{
Description: Attestation Type. ,
Enum:
{
none: No description available. ,
tpm: No description available. ,
x509: No description available. ,
symmetricKey: No description available. ,
}
,
Required: True ,
}
enum ,
tpm:
{
Description: TPM attestation method. ,
Required: False ,
}
{
endorsementKey:
{
Required: True ,
}
string ,
storageRootKey:
{
Required: False ,
}
string ,
}
,
x509:
{
Description: X509 attestation method. ,
Required: False ,
}
{
clientCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
signingCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
caReferences:
{
Description: Primary and secondary CA references. ,
Required: False ,
}
{
primary:
{
Required: False ,
}
string ,
secondary:
{
Required: False ,
}
string ,
}
,
}
,
symmetricKey:
{
Description: Symmetric Key attestation method. ,
Required: False ,
}
{
primaryKey:
{
Description: Primary symmetric key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary symmetric key. ,
Required: False ,
}
string ,
}
,
}
,
capabilities:
{
Description: Capabilities of the device. ,
Required: False ,
}
{
iotEdge:
{
Description: If set to true, this device is an IoTEdge device. ,
Required: True ,
}
boolean ,
}
,
iotHubHostName:
{
Description: The Iot Hub host name. ,
Required: False ,
}
string ,
initialTwin:
{
Description: Initial device twin. ,
Required: False ,
}
{
tags:
{
Description: Twin tags. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
properties:
{
Description: Twin desired properties. ,
Required: False ,
}
{
desired:
{
Description: Gets and sets the InitialTwin desired properties. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: The provisioning status. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reprovisionPolicy:
{
Description: The behavior when a device is re-provisioned to an IoT hub. ,
Required: False ,
}
{
updateHubAssignment:
{
Description: When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub. ,
Required: True ,
}
boolean ,
migrateDeviceData:
{
Description: When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the corresponding enrollment list. ,
Required: True ,
}
boolean ,
}
,
createdDateTimeUtc:
{
Description: The DateTime this resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: The DateTime this resource was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
allocationPolicy:
{
Description: The allocation policy of this resource. This policy overrides the tenant level allocation policy for this individual enrollment or enrollment group. Possible values include '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. ,
Enum:
{
hashed: No description available. ,
geoLatency: No description available. ,
static: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
iotHubs:
{
Description: The list of IoT Hub hostnames the device(s) in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs. ,
Required: False ,
}
[
string ,
]
,
customAllocationDefinition:
{
Description: This tells DPS which webhook to call when using custom allocation. ,
Required: False ,
}
{
webhookUrl:
{
Description: The webhook URL used for allocation requests. ,
Required: True ,
}
string ,
apiVersion:
{
Description: The API version of the provisioning service types (such as IndividualEnrollment) sent in the custom allocation request. Minimum supported version: "2018-09-01-preview". ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
EnrollmentGroup_Delete (new)
Description :  Delete a device enrollment group.
Reference :  Link ¶

⚼ Request

DELETE:  /enrollmentGroups/{id}
{
id:
{
Description: Enrollment group ID. ,
Required: True ,
}
string ,
If-Match:
{
Description: The ETag of the enrollment group record. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
DeviceRegistrationState_Get (new)
Description :  Gets the device registration state.
Reference :  Link ¶

⚼ Request

GET:  /registrations/{id}
{
id:
{
Description: Registration ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
registrationId:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: False ,
}
string ,
createdDateTimeUtc:
{
Description: Registration create date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
assignedHub:
{
Description: Assigned Azure IoT Hub. ,
Required: False ,
}
string ,
deviceId:
{
Description: Device ID. ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status. ,
Enum:
{
unassigned: No description available. ,
assigning: No description available. ,
assigned: No description available. ,
failed: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
substatus:
{
Description: 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, 'reprovisionedToInitialAssignment': Device has been re-provisioned to a previously assigned IoT hub. ,
Enum:
{
initialAssignment: No description available. ,
deviceDataMigrated: No description available. ,
deviceDataReset: No description available. ,
reprovisionedToInitialAssignment: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: Last updated date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
payload:
{
Description: Custom allocation payload returned from the webhook to the device. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
DeviceRegistrationState_Delete (new)
Description :  Deletes the device registration
Reference :  Link ¶

⚼ Request

DELETE:  /registrations/{id}
{
id:
{
Description: Registration ID. ,
Required: True ,
}
string ,
If-Match:
{
Description: The ETag of the registration status record. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
IndividualEnrollment_Query (new)
Description :  Query the device enrollment records.
Reference :  Link ¶

⚼ Request

POST:  /enrollments/query
{
x-ms-max-item-count:
{
Description: Page size ,
Format: int32 ,
Required: False ,
}
integer ,
x-ms-continuation:
{
Description: Continuation token ,
Required: False ,
}
string ,
querySpecification:
{
Description: The query specification. ,
Required: True ,
}
{
query:
{
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-continuation:
{
Description: The continuation token for getting the next page of results. ,
}
string ,
x-ms-max-item-count:
{
Description: The maximum number of items returned in a page. ,
}
integer ,
x-ms-item-type:
{
Description: The list of values returned from the query. ,
}
string ,
}
,
$schema:
{
registrationId:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: True ,
}
string ,
deviceId:
{
Description: Desired IoT Hub device ID (optional). ,
Required: False ,
}
string ,
registrationState:
{
Description: Current registration status. ,
Required: False ,
}
{
registrationId:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: False ,
}
string ,
createdDateTimeUtc:
{
Description: Registration create date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
assignedHub:
{
Description: Assigned Azure IoT Hub. ,
Required: False ,
}
string ,
deviceId:
{
Description: Device ID. ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status. ,
Enum:
{
unassigned: No description available. ,
assigning: No description available. ,
assigned: No description available. ,
failed: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
substatus:
{
Description: 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, 'reprovisionedToInitialAssignment': Device has been re-provisioned to a previously assigned IoT hub. ,
Enum:
{
initialAssignment: No description available. ,
deviceDataMigrated: No description available. ,
deviceDataReset: No description available. ,
reprovisionedToInitialAssignment: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: Last updated date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
payload:
{
Description: Custom allocation payload returned from the webhook to the device. ,
Required: False ,
}
object ,
}
,
optionalDeviceInformation:
{
Description: Optional Device Information. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
attestation:
{
Description: Attestation method used by the device. ,
Required: True ,
}
{
type:
{
Description: Attestation Type. ,
Enum:
{
none: No description available. ,
tpm: No description available. ,
x509: No description available. ,
symmetricKey: No description available. ,
}
,
Required: True ,
}
enum ,
tpm:
{
Description: TPM attestation method. ,
Required: False ,
}
{
endorsementKey:
{
Required: True ,
}
string ,
storageRootKey:
{
Required: False ,
}
string ,
}
,
x509:
{
Description: X509 attestation method. ,
Required: False ,
}
{
clientCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
signingCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
caReferences:
{
Description: Primary and secondary CA references. ,
Required: False ,
}
{
primary:
{
Required: False ,
}
string ,
secondary:
{
Required: False ,
}
string ,
}
,
}
,
symmetricKey:
{
Description: Symmetric Key attestation method. ,
Required: False ,
}
{
primaryKey:
{
Description: Primary symmetric key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary symmetric key. ,
Required: False ,
}
string ,
}
,
}
,
capabilities:
{
Description: Capabilities of the device. ,
Required: False ,
}
{
iotEdge:
{
Description: If set to true, this device is an IoTEdge device. ,
Required: True ,
}
boolean ,
}
,
iotHubHostName:
{
Description: The Iot Hub host name. ,
Required: False ,
}
string ,
initialTwin:
{
Description: Initial device twin. ,
Required: False ,
}
{
tags:
{
Description: Twin tags. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
properties:
{
Description: Twin desired properties. ,
Required: False ,
}
{
desired:
{
Description: Gets and sets the InitialTwin desired properties. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: The provisioning status. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reprovisionPolicy:
{
Description: The behavior when a device is re-provisioned to an IoT hub. ,
Required: False ,
}
{
updateHubAssignment:
{
Description: When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub. ,
Required: True ,
}
boolean ,
migrateDeviceData:
{
Description: When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the corresponding enrollment list. ,
Required: True ,
}
boolean ,
}
,
createdDateTimeUtc:
{
Description: The DateTime this resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: The DateTime this resource was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
allocationPolicy:
{
Description: The allocation policy of this resource. This policy overrides the tenant level allocation policy for this individual enrollment or enrollment group. Possible values include '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. ,
Enum:
{
hashed: No description available. ,
geoLatency: No description available. ,
static: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
iotHubs:
{
Description: The list of IoT Hub hostnames the device(s) in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs. ,
Required: False ,
}
[
string ,
]
,
customAllocationDefinition:
{
Description: This tells DPS which webhook to call when using custom allocation. ,
Required: False ,
}
{
webhookUrl:
{
Description: The webhook URL used for allocation requests. ,
Required: True ,
}
string ,
apiVersion:
{
Description: The API version of the provisioning service types (such as IndividualEnrollment) sent in the custom allocation request. Minimum supported version: "2018-09-01-preview". ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
IndividualEnrollment_GetAttestationMechanism (new)
Description :  Get the attestation mechanism in the device enrollment record.
Reference :  Link ¶

⚼ Request

POST:  /enrollments/{id}/attestationmechanism
{
id:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: Attestation Type. ,
Enum:
{
none: No description available. ,
tpm: No description available. ,
x509: No description available. ,
symmetricKey: No description available. ,
}
,
Required: True ,
}
enum ,
tpm:
{
Description: TPM attestation method. ,
Required: False ,
}
{
endorsementKey:
{
Required: True ,
}
string ,
storageRootKey:
{
Required: False ,
}
string ,
}
,
x509:
{
Description: X509 attestation method. ,
Required: False ,
}
{
clientCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
signingCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
caReferences:
{
Description: Primary and secondary CA references. ,
Required: False ,
}
{
primary:
{
Required: False ,
}
string ,
secondary:
{
Required: False ,
}
string ,
}
,
}
,
symmetricKey:
{
Description: Symmetric Key attestation method. ,
Required: False ,
}
{
primaryKey:
{
Description: Primary symmetric key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary symmetric key. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
IndividualEnrollment_RunBulkOperation (new)
Description :  Bulk device enrollment operation with maximum of 10 enrollments.
Reference :  Link ¶

⚼ Request

POST:  /enrollments
{
bulkOperation:
{
Description: Bulk operation. ,
Required: True ,
}
{
enrollments:
{
Description: Enrollment items ,
Required: True ,
}
[
{
registrationId:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: True ,
}
string ,
deviceId:
{
Description: Desired IoT Hub device ID (optional). ,
Required: False ,
}
string ,
registrationState:
{
Description: Current registration status. ,
Required: False ,
}
{
registrationId:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: False ,
}
string ,
createdDateTimeUtc:
{
Description: Registration create date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
assignedHub:
{
Description: Assigned Azure IoT Hub. ,
Required: False ,
}
string ,
deviceId:
{
Description: Device ID. ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status. ,
Enum:
{
unassigned: No description available. ,
assigning: No description available. ,
assigned: No description available. ,
failed: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
substatus:
{
Description: 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, 'reprovisionedToInitialAssignment': Device has been re-provisioned to a previously assigned IoT hub. ,
Enum:
{
initialAssignment: No description available. ,
deviceDataMigrated: No description available. ,
deviceDataReset: No description available. ,
reprovisionedToInitialAssignment: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: Last updated date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
payload:
{
Description: Custom allocation payload returned from the webhook to the device. ,
Required: False ,
}
object ,
}
,
optionalDeviceInformation:
{
Description: Optional Device Information. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
attestation:
{
Description: Attestation method used by the device. ,
Required: True ,
}
{
type:
{
Description: Attestation Type. ,
Enum:
{
none: No description available. ,
tpm: No description available. ,
x509: No description available. ,
symmetricKey: No description available. ,
}
,
Required: True ,
}
enum ,
tpm:
{
Description: TPM attestation method. ,
Required: False ,
}
{
endorsementKey:
{
Required: True ,
}
string ,
storageRootKey:
{
Required: False ,
}
string ,
}
,
x509:
{
Description: X509 attestation method. ,
Required: False ,
}
{
clientCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
signingCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
caReferences:
{
Description: Primary and secondary CA references. ,
Required: False ,
}
{
primary:
{
Required: False ,
}
string ,
secondary:
{
Required: False ,
}
string ,
}
,
}
,
symmetricKey:
{
Description: Symmetric Key attestation method. ,
Required: False ,
}
{
primaryKey:
{
Description: Primary symmetric key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary symmetric key. ,
Required: False ,
}
string ,
}
,
}
,
capabilities:
{
Description: Capabilities of the device. ,
Required: False ,
}
{
iotEdge:
{
Description: If set to true, this device is an IoTEdge device. ,
Required: True ,
}
boolean ,
}
,
iotHubHostName:
{
Description: The Iot Hub host name. ,
Required: False ,
}
string ,
initialTwin:
{
Description: Initial device twin. ,
Required: False ,
}
{
tags:
{
Description: Twin tags. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
properties:
{
Description: Twin desired properties. ,
Required: False ,
}
{
desired:
{
Description: Gets and sets the InitialTwin desired properties. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: The provisioning status. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reprovisionPolicy:
{
Description: The behavior when a device is re-provisioned to an IoT hub. ,
Required: False ,
}
{
updateHubAssignment:
{
Description: When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub. ,
Required: True ,
}
boolean ,
migrateDeviceData:
{
Description: When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the corresponding enrollment list. ,
Required: True ,
}
boolean ,
}
,
createdDateTimeUtc:
{
Description: The DateTime this resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: The DateTime this resource was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
allocationPolicy:
{
Description: The allocation policy of this resource. This policy overrides the tenant level allocation policy for this individual enrollment or enrollment group. Possible values include '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. ,
Enum:
{
hashed: No description available. ,
geoLatency: No description available. ,
static: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
iotHubs:
{
Description: The list of IoT Hub hostnames the device(s) in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs. ,
Required: False ,
}
[
string ,
]
,
customAllocationDefinition:
{
Description: This tells DPS which webhook to call when using custom allocation. ,
Required: False ,
}
{
webhookUrl:
{
Description: The webhook URL used for allocation requests. ,
Required: True ,
}
string ,
apiVersion:
{
Description: The API version of the provisioning service types (such as IndividualEnrollment) sent in the custom allocation request. Minimum supported version: "2018-09-01-preview". ,
Required: True ,
}
string ,
}
,
}
,
]
,
mode:
{
Description: Operation mode. ,
Enum:
{
create: No description available. ,
update: No description available. ,
updateIfMatchETag: No description available. ,
delete: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
errors:
{
Description: Registration errors ,
Required: False ,
}
[
{
registrationId:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: True ,
}
string ,
errorCode:
{
Description: Error code ,
Format: int32 ,
Required: True ,
}
integer ,
errorStatus:
{
Description: Error status. ,
Required: True ,
}
string ,
}
,
]
,
isSuccessful:
{
Description: Indicates if the operation was successful in its entirety. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
EnrollmentGroup_Query (new)
Description :  Query the device enrollment groups.
Reference :  Link ¶

⚼ Request

POST:  /enrollmentGroups/query
{
x-ms-max-item-count:
{
Description: Page size ,
Format: int32 ,
Required: False ,
}
integer ,
x-ms-continuation:
{
Description: Continuation token ,
Required: False ,
}
string ,
querySpecification:
{
Description: The query specification. ,
Required: True ,
}
{
query:
{
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-continuation:
{
Description: The continuation token for getting the next page of results. ,
}
string ,
x-ms-max-item-count:
{
Description: The maximum number of items returned in a page. ,
}
integer ,
x-ms-item-type:
{
Description: The list of values returned from the query. ,
}
string ,
}
,
$schema:
{
enrollmentGroupId:
{
Description: Enrollment Group ID. ,
Required: True ,
}
string ,
attestation:
{
Description: Attestation method used by the device. ,
Required: True ,
}
{
type:
{
Description: Attestation Type. ,
Enum:
{
none: No description available. ,
tpm: No description available. ,
x509: No description available. ,
symmetricKey: No description available. ,
}
,
Required: True ,
}
enum ,
tpm:
{
Description: TPM attestation method. ,
Required: False ,
}
{
endorsementKey:
{
Required: True ,
}
string ,
storageRootKey:
{
Required: False ,
}
string ,
}
,
x509:
{
Description: X509 attestation method. ,
Required: False ,
}
{
clientCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
signingCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
caReferences:
{
Description: Primary and secondary CA references. ,
Required: False ,
}
{
primary:
{
Required: False ,
}
string ,
secondary:
{
Required: False ,
}
string ,
}
,
}
,
symmetricKey:
{
Description: Symmetric Key attestation method. ,
Required: False ,
}
{
primaryKey:
{
Description: Primary symmetric key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary symmetric key. ,
Required: False ,
}
string ,
}
,
}
,
capabilities:
{
Description: Capabilities of the device. ,
Required: False ,
}
{
iotEdge:
{
Description: If set to true, this device is an IoTEdge device. ,
Required: True ,
}
boolean ,
}
,
iotHubHostName:
{
Description: The Iot Hub host name. ,
Required: False ,
}
string ,
initialTwin:
{
Description: Initial device twin. ,
Required: False ,
}
{
tags:
{
Description: Twin tags. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
properties:
{
Description: Twin desired properties. ,
Required: False ,
}
{
desired:
{
Description: Gets and sets the InitialTwin desired properties. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: The provisioning status. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reprovisionPolicy:
{
Description: The behavior when a device is re-provisioned to an IoT hub. ,
Required: False ,
}
{
updateHubAssignment:
{
Description: When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub. ,
Required: True ,
}
boolean ,
migrateDeviceData:
{
Description: When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the corresponding enrollment list. ,
Required: True ,
}
boolean ,
}
,
createdDateTimeUtc:
{
Description: The DateTime this resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: The DateTime this resource was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
allocationPolicy:
{
Description: The allocation policy of this resource. This policy overrides the tenant level allocation policy for this individual enrollment or enrollment group. Possible values include '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. ,
Enum:
{
hashed: No description available. ,
geoLatency: No description available. ,
static: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
iotHubs:
{
Description: The list of IoT Hub hostnames the device(s) in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs. ,
Required: False ,
}
[
string ,
]
,
customAllocationDefinition:
{
Description: This tells DPS which webhook to call when using custom allocation. ,
Required: False ,
}
{
webhookUrl:
{
Description: The webhook URL used for allocation requests. ,
Required: True ,
}
string ,
apiVersion:
{
Description: The API version of the provisioning service types (such as IndividualEnrollment) sent in the custom allocation request. Minimum supported version: "2018-09-01-preview". ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
EnrollmentGroup_GetAttestationMechanism (new)
Description :  Get the attestation mechanism in the device enrollment group record.
Reference :  Link ¶

⚼ Request

POST:  /enrollmentGroups/{id}/attestationmechanism
{
id:
{
Description: Enrollment group ID ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: Attestation Type. ,
Enum:
{
none: No description available. ,
tpm: No description available. ,
x509: No description available. ,
symmetricKey: No description available. ,
}
,
Required: True ,
}
enum ,
tpm:
{
Description: TPM attestation method. ,
Required: False ,
}
{
endorsementKey:
{
Required: True ,
}
string ,
storageRootKey:
{
Required: False ,
}
string ,
}
,
x509:
{
Description: X509 attestation method. ,
Required: False ,
}
{
clientCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
signingCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
caReferences:
{
Description: Primary and secondary CA references. ,
Required: False ,
}
{
primary:
{
Required: False ,
}
string ,
secondary:
{
Required: False ,
}
string ,
}
,
}
,
symmetricKey:
{
Description: Symmetric Key attestation method. ,
Required: False ,
}
{
primaryKey:
{
Description: Primary symmetric key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary symmetric key. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
EnrollmentGroup_RunBulkOperation (new)
Description :  Bulk device enrollment group operation with maximum of 10 groups.
Reference :  Link ¶

⚼ Request

POST:  /enrollmentGroups
{
bulkOperation:
{
Description: Bulk operation. ,
Required: True ,
}
{
enrollmentGroups:
{
Description: Enrollment items ,
Required: True ,
}
[
{
enrollmentGroupId:
{
Description: Enrollment Group ID. ,
Required: True ,
}
string ,
attestation:
{
Description: Attestation method used by the device. ,
Required: True ,
}
{
type:
{
Description: Attestation Type. ,
Enum:
{
none: No description available. ,
tpm: No description available. ,
x509: No description available. ,
symmetricKey: No description available. ,
}
,
Required: True ,
}
enum ,
tpm:
{
Description: TPM attestation method. ,
Required: False ,
}
{
endorsementKey:
{
Required: True ,
}
string ,
storageRootKey:
{
Required: False ,
}
string ,
}
,
x509:
{
Description: X509 attestation method. ,
Required: False ,
}
{
clientCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
signingCertificates:
{
Description: Primary and secondary certificates ,
Required: False ,
}
{
primary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
secondary:
{
Description: Certificate and Certificate info ,
Required: False ,
}
{
certificate:
{
Required: False ,
}
string ,
info:
{
Description: X509 certificate info. ,
Required: False ,
}
{
subjectName:
{
Required: True ,
}
string ,
sha1Thumbprint:
{
Required: True ,
}
string ,
sha256Thumbprint:
{
Required: True ,
}
string ,
issuerName:
{
Required: True ,
}
string ,
notBeforeUtc:
{
Format: date-time ,
Required: True ,
}
string ,
notAfterUtc:
{
Format: date-time ,
Required: True ,
}
string ,
serialNumber:
{
Required: True ,
}
string ,
version:
{
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
caReferences:
{
Description: Primary and secondary CA references. ,
Required: False ,
}
{
primary:
{
Required: False ,
}
string ,
secondary:
{
Required: False ,
}
string ,
}
,
}
,
symmetricKey:
{
Description: Symmetric Key attestation method. ,
Required: False ,
}
{
primaryKey:
{
Description: Primary symmetric key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary symmetric key. ,
Required: False ,
}
string ,
}
,
}
,
capabilities:
{
Description: Capabilities of the device. ,
Required: False ,
}
{
iotEdge:
{
Description: If set to true, this device is an IoTEdge device. ,
Required: True ,
}
boolean ,
}
,
iotHubHostName:
{
Description: The Iot Hub host name. ,
Required: False ,
}
string ,
initialTwin:
{
Description: Initial device twin. ,
Required: False ,
}
{
tags:
{
Description: Twin tags. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
properties:
{
Description: Twin desired properties. ,
Required: False ,
}
{
desired:
{
Description: Gets and sets the InitialTwin desired properties. ,
Required: False ,
}
{
version:
{
Description: Version of the TwinCollection ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: Number of properties in the TwinCollection ,
Required: False ,
}
integer ,
metadata:
{
Description: Metadata for the TwinCollection ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time the TwinCollection was updated ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedVersion:
{
Description: This is null for reported properties metadata and is not null for desired properties metadata. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
provisioningStatus:
{
Description: The provisioning status. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reprovisionPolicy:
{
Description: The behavior when a device is re-provisioned to an IoT hub. ,
Required: False ,
}
{
updateHubAssignment:
{
Description: When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub. ,
Required: True ,
}
boolean ,
migrateDeviceData:
{
Description: When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the corresponding enrollment list. ,
Required: True ,
}
boolean ,
}
,
createdDateTimeUtc:
{
Description: The DateTime this resource was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: The DateTime this resource was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
allocationPolicy:
{
Description: The allocation policy of this resource. This policy overrides the tenant level allocation policy for this individual enrollment or enrollment group. Possible values include '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. ,
Enum:
{
hashed: No description available. ,
geoLatency: No description available. ,
static: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
iotHubs:
{
Description: The list of IoT Hub hostnames the device(s) in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs. ,
Required: False ,
}
[
string ,
]
,
customAllocationDefinition:
{
Description: This tells DPS which webhook to call when using custom allocation. ,
Required: False ,
}
{
webhookUrl:
{
Description: The webhook URL used for allocation requests. ,
Required: True ,
}
string ,
apiVersion:
{
Description: The API version of the provisioning service types (such as IndividualEnrollment) sent in the custom allocation request. Minimum supported version: "2018-09-01-preview". ,
Required: True ,
}
string ,
}
,
}
,
]
,
mode:
{
Description: Operation mode. ,
Enum:
{
create: No description available. ,
update: No description available. ,
updateIfMatchETag: No description available. ,
delete: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
errors:
{
Description: Registration errors ,
Required: False ,
}
[
{
enrollmentGroupId:
{
Description: Enrollment group id. ,
Required: True ,
}
string ,
errorCode:
{
Description: Error code ,
Format: int32 ,
Required: True ,
}
integer ,
errorStatus:
{
Description: Error status. ,
Required: True ,
}
string ,
}
,
]
,
isSuccessful:
{
Description: Indicates if the operation was successful in its entirety. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}
DeviceRegistrationState_Query (new)
Description :  Gets the registration state of devices in this enrollmentGroup.
Reference :  Link ¶

⚼ Request

POST:  /registrations/{id}/query
{
id:
{
Description: Enrollment group ID. ,
Required: True ,
}
string ,
x-ms-max-item-count:
{
Description: pageSize ,
Format: int32 ,
Required: False ,
}
integer ,
x-ms-continuation:
{
Description: continuation token ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for the request. Supported versions include: 2021-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-continuation:
{
Description: The continuation token for getting the next page of results. ,
}
string ,
x-ms-max-item-count:
{
Description: The maximum number of items returned in a page. ,
}
integer ,
x-ms-item-type:
{
Description: The list of values returned from the query. ,
}
string ,
}
,
$schema:
{
registrationId:
{
Description: This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. ,
Required: False ,
}
string ,
createdDateTimeUtc:
{
Description: Registration create date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
assignedHub:
{
Description: Assigned Azure IoT Hub. ,
Required: False ,
}
string ,
deviceId:
{
Description: Device ID. ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status. ,
Enum:
{
unassigned: No description available. ,
assigning: No description available. ,
assigned: No description available. ,
failed: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
substatus:
{
Description: 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, 'reprovisionedToInitialAssignment': Device has been re-provisioned to a previously assigned IoT hub. ,
Enum:
{
initialAssignment: No description available. ,
deviceDataMigrated: No description available. ,
deviceDataReset: No description available. ,
reprovisionedToInitialAssignment: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
lastUpdatedDateTimeUtc:
{
Description: Last updated date time (in UTC). ,
Format: date-time ,
Required: False ,
}
string ,
etag:
{
Description: The entity tag associated with the resource. ,
Required: False ,
}
string ,
payload:
{
Description: Custom allocation payload returned from the webhook to the device. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. ,
}
{
errorCode:
{
Format: int32 ,
Required: False ,
}
integer ,
trackingId:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
info:
{
Required: False ,
}
object ,
timestampUtc:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
}