Device Registration State - Query

  • Reference
Service:
IoT Hub Device Provisioning Service
API Version:
2021-06-01

Gets the registration state of devices in this enrollmentGroup.

POST https://your-dps.azure-devices-provisioning.net/registrations/{id}/query?api-version=2021-06-01

URI Parameters

Name In Required Type Description
id
 path True

string

Enrollment group ID.
api-version
 query True

string

The API version to use for the request. Supported versions include: 2021-06-01

Request Header

Name Required Type Description
x-ms-max-item-count

integer

int32

pageSize
x-ms-continuation

string

continuation token

Responses

Name Type Description
200 OK

DeviceRegistrationState[]

Success

Headers

  • x-ms-continuation: string
  • x-ms-max-item-count: integer
  • x-ms-item-type: string
Other Status Codes

ProvisioningServiceErrorDetails

Error response

Definitions

Name Description
DeviceRegistrationState

Device registration state.
ProvisioningServiceErrorDetails

Contains the properties of an error returned by the Azure IoT Hub Provisioning Service.

DeviceRegistrationState

Device registration state.

Name Type Description
assignedHub

string

Assigned Azure IoT Hub.
createdDateTimeUtc

string

Registration create date time (in UTC).
deviceId

string

Device ID.
errorCode

integer

Error code.
errorMessage

string

Error message.
etag

string

The entity tag associated with the resource.
lastUpdatedDateTimeUtc

string

Last updated date time (in UTC).
payload

object

Custom allocation payload returned from the webhook to the device.
registrationId

string

The registration ID is alphanumeric, lowercase, and may contain hyphens.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Enrollment status.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

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.

ProvisioningServiceErrorDetails

Contains the properties of an error returned by the Azure IoT Hub Provisioning Service.

Name Type Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string