Share via

Runtime Registration - Device Registration Status Lookup

Service:
IoT Hub Device Provisioning Service
API Version:
2021-10-01

Gets the device registration status.

POST https://global.azure-devices-provisioning.net/{idScope}/registrations/{registrationId}?api-version=2021-10-01

URI Parameters

Name In Required Type Description
idScope
 path True

string

registrationId
 path True

string

Registration ID.
api-version
 query True

string

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

Request Body

Name Type Description
payload

object

registrationId

string

The registration ID is a case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end.
tpm

TpmAttestation

Attestation via TPM.

Responses

Name Type Description
200 OK

DeviceRegistrationResult

Success
Other Status Codes

ProvisioningServiceErrorDetails

Error response

Headers

x-ms-error-code: string

Definitions

Name Description
DeviceRegistration

Device registration.
DeviceRegistrationResult

Device registration result.
ProvisioningServiceErrorDetails

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

Registration result returned when using SymmetricKey attestation.
TpmAttestation

Attestation via TPM.
TpmRegistrationResult

TPM registration result.
X509CertificateInfo

X509 certificate info.
X509RegistrationResult

X509 registration result.

DeviceRegistration

Object

Device registration.

Name Type Description
payload

object

registrationId

string

The registration ID is a case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end.
tpm

TpmAttestation

Attestation via TPM.

DeviceRegistrationResult

Object

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.
lastUpdatedDateTimeUtc

string (date-time)

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.
symmetricKey

SymmetricKeyRegistrationResult

Registration result returned when using SymmetricKey attestation.
tpm

TpmRegistrationResult

TPM registration result.
x509

X509RegistrationResult

X509 registration result.

ProvisioningServiceErrorDetails

Object

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

Name Type Description
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string

SymmetricKeyRegistrationResult

Object

Registration result returned when using SymmetricKey attestation.

Name Type Description
enrollmentGroupId

string

TpmAttestation

Object

Attestation via TPM.

Name Type Description
endorsementKey

string

storageRootKey

string

TpmRegistrationResult

Object

TPM registration result.

Name Type Description
authenticationKey

string

Encrypted authentication key.

X509CertificateInfo

Object

X509 certificate info.

Name Type Description
issuerName

string

notAfterUtc

string (date-time)

notBeforeUtc

string (date-time)

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer (int32)

X509RegistrationResult

Object

X509 registration result.

Name Type Description
certificateInfo

X509CertificateInfo

X509 certificate info.
enrollmentGroupId

string

signingCertificateInfo

X509CertificateInfo

X509 certificate info.