Device Registration State - Get

Gets the device registration state.

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

URI Parameters

Name	In	Required	Type	Description
id	path	True	string	Registration ID.
api-version	query	True	string	The API version to use for the request. Supported versions include: 2021-10-01

Name	Type	Description
200 OK	DeviceRegistrationState	Success
Other Status Codes	ProvisioningServiceErrorDetails	Error response Headers x-ms-error-code: string

Name

Type

Description

200 OK

Success

Other Status Codes

Error response

Headers

x-ms-error-code: string

Name	Description
DeviceRegistrationState	Device registration state.
ProvisioningServiceErrorDetails	Contains the properties of an error returned by the Azure IoT Hub Provisioning Service.

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
registrationId	string	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.
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.

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