Runtime Registration - Operation Status Lookup
Gets the registration operation status.
GET https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}/operations/{operationId}?api-version=2026-11-01
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
id
|
path | True |
string |
The scope of the DPS instance. |
|
operation
|
path | True |
string |
Operation ID. |
|
registration
|
path | True |
string |
Registration ID. |
|
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
The request has succeeded. |
|
| 202 Accepted |
The request has been accepted for processing, but processing has not yet completed. Headers
|
|
| Other Status Codes |
An unexpected error response. Headers x-ms-error-code: string |
Examples
|
Runtime |
|
Runtime |
RuntimeRegistration_OperationStatusLookup_MaximumSet_Gen
Sample request
GET https://global.azure-devices-provisioning.net/arjoldcjeedohmpuhenotyesppkgk/registrations/ojruvwccsgwnmscfwodrfjrecxuf/operations/fdjhztahuvcjjmutvihsmflepzvsfn?api-version=2026-11-01
Sample response
{
"operationId": "xosjboksmobnotwgqejpvxiwi",
"registrationState": {
"assignedHub": "ljexps",
"createdDateTimeUtc": "2025-10-01T17:41:56.535Z",
"deviceId": "hjvdlwpugzlk",
"errorCode": 13,
"errorMessage": "zpctqazbkbiqjkwosis",
"etag": "hjtelksspyfzhmet",
"issuedCertificateChain": [
"MIIBkTCB+wIBADAZMRcwFQYDVQQDDA5leGFtcGxlLWRldmljZTCBnzANBgkqhkiG9w0BAQEFAAOBjQAw"
],
"lastUpdatedDateTimeUtc": "2025-10-01T17:41:56.535Z",
"payload": {},
"registrationId": "urejrffpkqneou",
"status": "unassigned",
"substatus": "initialAssignment",
"symmetricKey": {
"enrollmentGroupId": "w"
},
"tpm": {
"authenticationKey": "sofbxakhjrxpiyysjjxkx"
},
"x509": {
"certificateInfo": {
"issuerName": "pvpbipnhcahytrcq",
"notAfterUtc": "2025-10-01T17:41:56.534Z",
"notBeforeUtc": "2025-10-01T17:41:56.534Z",
"serialNumber": "jjvdijgwgpagrjdi",
"sha1Thumbprint": "guqltcfgusf",
"sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
"subjectName": "jtsfqnbcmmott",
"version": 20
},
"enrollmentGroupId": "qbw",
"signingCertificateInfo": {
"issuerName": "pvpbipnhcahytrcq",
"notAfterUtc": "2025-10-01T17:41:56.534Z",
"notBeforeUtc": "2025-10-01T17:41:56.534Z",
"serialNumber": "jjvdijgwgpagrjdi",
"sha1Thumbprint": "guqltcfgusf",
"sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
"subjectName": "jtsfqnbcmmott",
"version": 20
}
}
},
"status": "unassigned"
}
{
"operationId": "xosjboksmobnotwgqejpvxiwi",
"registrationState": {
"assignedHub": "ljexps",
"createdDateTimeUtc": "2025-10-01T17:41:56.535Z",
"deviceId": "hjvdlwpugzlk",
"errorCode": 13,
"errorMessage": "zpctqazbkbiqjkwosis",
"etag": "hjtelksspyfzhmet",
"issuedCertificateChain": [
"MIIBkTCB+wIBADAZMRcwFQYDVQQDDA5leGFtcGxlLWRldmljZTCBnzANBgkqhkiG9w0BAQEFAAOBjQAw"
],
"lastUpdatedDateTimeUtc": "2025-10-01T17:41:56.535Z",
"payload": {},
"registrationId": "urejrffpkqneou",
"status": "unassigned",
"substatus": "initialAssignment",
"symmetricKey": {
"enrollmentGroupId": "w"
},
"tpm": {
"authenticationKey": "sofbxakhjrxpiyysjjxkx"
},
"x509": {
"certificateInfo": {
"issuerName": "pvpbipnhcahytrcq",
"notAfterUtc": "2025-10-01T17:41:56.534Z",
"notBeforeUtc": "2025-10-01T17:41:56.534Z",
"serialNumber": "jjvdijgwgpagrjdi",
"sha1Thumbprint": "guqltcfgusf",
"sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
"subjectName": "jtsfqnbcmmott",
"version": 20
},
"enrollmentGroupId": "qbw",
"signingCertificateInfo": {
"issuerName": "pvpbipnhcahytrcq",
"notAfterUtc": "2025-10-01T17:41:56.534Z",
"notBeforeUtc": "2025-10-01T17:41:56.534Z",
"serialNumber": "jjvdijgwgpagrjdi",
"sha1Thumbprint": "guqltcfgusf",
"sha256Thumbprint": "ysryarleygpkejrjlwuxacvcwbxqw",
"subjectName": "jtsfqnbcmmott",
"version": 20
}
}
},
"status": "unassigned"
}
RuntimeRegistration_OperationStatusLookup_MinimumSet_Gen
Sample request
GET https://global.azure-devices-provisioning.net/cxcukjqvjopedcgnhtggfdt/registrations/pzgoamgarcmcwvapl/operations/wacw?api-version=2026-11-01
Sample response
{
"operationId": "xosjboksmobnotwgqejpvxiwi"
}
{
"operationId": "xosjboksmobnotwgqejpvxiwi"
}
Definitions
| Name | Description |
|---|---|
|
Assigned |
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. |
|
Device |
Device registration result. |
|
Enrollment |
Enrollment status. |
|
Provisioning |
Contains the properties of an error returned by the Azure IoT Hub Provisioning Service. |
|
Registration |
Registration operation status. |
|
Symmetric |
Registration result returned when using SymmetricKey attestation. |
|
Tpm |
TPM registration result. |
|
X509Certificate |
X509 certificate info. |
|
X509Registration |
X509 registration result. |
AssignedDeviceSubstatus
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.
| Value | Description |
|---|---|
| initialAssignment |
initialAssignment |
| deviceDataMigrated |
deviceDataMigrated |
| deviceDataReset |
deviceDataReset |
| reprovisionedToInitialAssignment |
reprovisionedToInitialAssignment |
DeviceRegistrationResult
Device registration result.
| Name | Type | Description |
|---|---|---|
| assignedHub |
string |
Assigned Azure IoT Hub. |
| createdDateTimeUtc |
string (date-time) |
Registration create date time (in UTC). |
| deviceId |
string |
Device ID. |
| errorCode |
integer (int32) |
Error code. |
| errorMessage |
string |
Error message. |
| etag |
string |
The entity tag associated with the resource. |
| issuedCertificateChain |
string[] (byte) |
An array containing the full certificate chain for the issued certificate. The first element is the issued leaf certificate, followed by any intermediate certification authorities (ICAs), and ending with the root certification authority (CA). Each certificate in the array is the issuer of the previous certificate. This property is not included in responses for the RuntimeRegistration_DeviceRegistrationStatusLookup operation. |
| lastUpdatedDateTimeUtc |
string (date-time) |
Last updated date time (in UTC). |
| payload |
global.azure-devices-provisioning.net.iot-dps.data-plane.runtimeregistration.operationstatuslookup |
Any 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 |
Enrollment status. |
|
| substatus |
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. |
|
| symmetricKey |
Registration result returned when using SymmetricKey attestation. |
|
| tpm |
TPM registration result. |
|
| x509 |
X509 registration result. |
EnrollmentStatus
Enrollment status.
| Value | Description |
|---|---|
| unassigned |
unassigned |
| assigning |
assigning |
| assigned |
assigned |
| failed |
failed |
| disabled |
disabled |
ProvisioningServiceErrorDetails
Contains the properties of an error returned by the Azure IoT Hub Provisioning Service.
| Name | Type | Description |
|---|---|---|
| errorCode |
integer (int32) |
Numeric error code. |
| info |
object |
Dictionary of <string> |
| message |
string |
Error message. |
| timestampUtc |
string (date-time) |
Error timestamp (UTC). |
| trackingId |
string |
Error tracking ID. |
RegistrationOperationStatus
Registration operation status.
| Name | Type | Description |
|---|---|---|
| operationId |
string minLength: 1 |
Operation ID. |
| registrationState |
Device registration result. |
|
| status |
Device enrollment status. |
SymmetricKeyRegistrationResult
Registration result returned when using SymmetricKey attestation.
| Name | Type | Description |
|---|---|---|
| enrollmentGroupId |
string |
Enrollment group ID. |
TpmRegistrationResult
TPM registration result.
| Name | Type | Description |
|---|---|---|
| authenticationKey |
string |
Encrypted authentication key. |
X509CertificateInfo
X509 certificate info.
| Name | Type | Description |
|---|---|---|
| issuerName |
string |
Certificate issuer name. |
| notAfterUtc |
string (date-time) |
Certificate expiry date (UTC). |
| notBeforeUtc |
string (date-time) |
Certificate validity start date (UTC). |
| serialNumber |
string |
Certificate serial number. |
| sha1Thumbprint |
string |
SHA-1 thumbprint of the certificate. |
| sha256Thumbprint |
string |
SHA-256 thumbprint of the certificate. |
| subjectName |
string |
Certificate subject name. |
| version |
integer (int32) |
Certificate version. |
X509RegistrationResult
X509 registration result.
| Name | Type | Description |
|---|---|---|
| certificateInfo |
X509 certificate info. |
|
| enrollmentGroupId |
string |
Enrollment group ID. |
| signingCertificateInfo |
X509 certificate info. |