Runtime Registration - Device Registration Status Lookup

Service:: IoT Hub Device Provisioning Service

Version d’API:: 2026-11-01

Obtient l’état d’inscription de l’appareil.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
idScope	path	True	string	L’étendue de l’instance DPS.
registrationId	path	True	string	ID d’inscription.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
csr	string	Une demande de signature de certificat DER (CSR) codée en Base64 au format PKCS #10, à l’exclusion des en-têtes et pieds de page PEM. Le Nom Commun (CN) doit correspondre à l’Identifiant d’enregistrement de l’appareil. Inclure ce champ dans l’opération RuntimeRegistration_DeviceRegistrationStatusLookup entraînera une mauvaise demande.
payload		Tout objet
registrationId	string	L’ID d’enregistrement est une chaîne insensible aux majuscules (jusqu’à 128 caractères) composée de caractères alphanumériques plus certains caractères spéciaux : . _ -. Aucun personnage spécial n’est autorisé au début ou à la fin.
tpm	TpmAttestation	Attestation via TPM.

Réponses

Nom	Type	Description
200 OK	DeviceRegistrationResult	La demande a réussi.
Other Status Codes	ProvisioningServiceErrorDetails	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

DeviceRegistrationResult

La demande a réussi.

Other Status Codes

ProvisioningServiceErrorDetails

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Exemples

RuntimeRegistration_DeviceRegistrationStatusLookup_MaximumSet_Gen

RuntimeRegistration_DeviceRegistrationStatusLookup_MinimumSet_Gen

RuntimeRegistration_DeviceRegistrationStatusLookup_MaximumSet_Gen

Exemple de requête

HTTP

POST https://global.azure-devices-provisioning.net/a/registrations/urnfaaodcvbbllnmxj?api-version=2026-11-01

{
  "payload": {},
  "registrationId": "qypnuerjeunzogqdezhjgisfr",
  "tpm": {
    "endorsementKey": "sbvvzftylrpsetexcmnijtdezppq",
    "storageRootKey": "juohyrayid"
  }
}

Exemple de réponse

Code d’état:: 200

{
  "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
    }
  }
}

RuntimeRegistration_DeviceRegistrationStatusLookup_MinimumSet_Gen

Exemple de requête

HTTP

POST https://global.azure-devices-provisioning.net/mucolayhjusj/registrations/okxnmx?api-version=2026-11-01

{}

Exemple de réponse

Code d’état:: 200

{}

Définitions

Nom	Description
AssignedDeviceSubstatus	Sous-statut pour les appareils « Assignés ». Les valeurs possibles incluent : « initialAssignment » : l’appareil a été assigné à un hub IoT pour la première fois, « deviceDataMigrated » : l’appareil a été assigné à un autre hub IoT et ses données d’appareil ont été migrées depuis le hub IoT précédemment attribué. Les données de l’appareil ont été retirées du hub IoT précédemment assigné, « deviceDataReset » : l’appareil a été attribué à un autre hub IoT et ses données d’appareil ont été remplies à partir de l’état initial stocké dans l’inscription. Les données de l’appareil ont été retirées du hub IoT précédemment assigné, « reprovisionedToInitialAssignment » : L’appareil a été re-provisionné vers un hub IoT précédemment assigné.
DeviceRegistration	Inscription de l’appareil
DeviceRegistrationResult	Résultat de l’enregistrement des appareils.
EnrollmentStatus	Statut d’inscription.
ProvisioningServiceErrorDetails	Contient les propriétés d’une erreur retournée par le service de provisionnement Azure IoT Hub.
SymmetricKeyRegistrationResult	Résultat d’enregistrement renvoyé lors de l’utilisation de l’attestation SymmetricKey.
TpmAttestation	Attestation via TPM.
TpmRegistrationResult	Résultat de l’enregistrement TPM.
X509CertificateInfo	Informations sur le certificat X509.
X509RegistrationResult	Résultat de l’immatriculation X509.

AssignedDeviceSubstatus

Énumération

Sous-statut pour les appareils « Assignés ». Les valeurs possibles incluent : « initialAssignment » : l’appareil a été assigné à un hub IoT pour la première fois, « deviceDataMigrated » : l’appareil a été assigné à un autre hub IoT et ses données d’appareil ont été migrées depuis le hub IoT précédemment attribué. Les données de l’appareil ont été retirées du hub IoT précédemment assigné, « deviceDataReset » : l’appareil a été attribué à un autre hub IoT et ses données d’appareil ont été remplies à partir de l’état initial stocké dans l’inscription. Les données de l’appareil ont été retirées du hub IoT précédemment assigné, « reprovisionedToInitialAssignment » : L’appareil a été re-provisionné vers un hub IoT précédemment assigné.

Valeur	Description
initialAssignment	initialAssignment
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionedToInitialAssignment

DeviceRegistration

Objet

Inscription de l’appareil

Nom	Type	Description
csr	string	Une demande de signature de certificat DER (CSR) codée en Base64 au format PKCS #10, à l’exclusion des en-têtes et pieds de page PEM. Le Nom Commun (CN) doit correspondre à l’Identifiant d’enregistrement de l’appareil. Inclure ce champ dans l’opération RuntimeRegistration_DeviceRegistrationStatusLookup entraînera une mauvaise demande.
payload		Tout objet
registrationId	string	L’ID d’enregistrement est une chaîne insensible aux majuscules (jusqu’à 128 caractères) composée de caractères alphanumériques plus certains caractères spéciaux : . _ -. Aucun personnage spécial n’est autorisé au début ou à la fin.
tpm	TpmAttestation	Attestation via TPM.

DeviceRegistrationResult

Objet

Résultat de l’enregistrement des appareils.

Nom	Type	Description
assignedHub	string	Assigné Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Inscription crée la date-heure (dans UTC).
deviceId	string	ID de périphérique.
errorCode	integer (int32)	Code d’erreur.
errorMessage	string	Message d’erreur.
etag	string	L’entité tag associée à la ressource.
issuedCertificateChain	string[] (byte)	Un tableau contenant la chaîne complète de certificats du certificat émis. Le premier élément est le certificat de feuille délivré, suivi par toute autorité de certification intermédiaire (ICA), et se terminant par l’autorité de certification de base (CA). Chaque certificat dans le tableau est l’émetteur du certificat précédent. Cette propriété n’est pas incluse dans les réponses pour l’opération RuntimeRegistration_DeviceRegistrationStatusLookup.
lastUpdatedDateTimeUtc	string (date-time)	Dernière date mise à jour, heure (dans UTC).
payload		Tout objet
registrationId	string	Cet identifiant est utilisé pour identifier de manière unique l’enregistrement d’un appareil d’une inscription. Une chaîne insensible à la casse (jusqu’à 128 caractères) de caractères alphanumériques plus certains caractères spéciaux : . _ -. Aucun personnage spécial n’est autorisé au début ou à la fin.
status	EnrollmentStatus	Statut d’inscription.
substatus	AssignedDeviceSubstatus	Sous-statut pour les appareils « Assignés ». Les valeurs possibles incluent : « initialAssignment » : l’appareil a été assigné à un hub IoT pour la première fois, « deviceDataMigrated » : l’appareil a été assigné à un autre hub IoT et ses données d’appareil ont été migrées depuis le hub IoT précédemment attribué. Les données de l’appareil ont été retirées du hub IoT précédemment assigné, « deviceDataReset » : l’appareil a été attribué à un autre hub IoT et ses données d’appareil ont été remplies à partir de l’état initial stocké dans l’inscription. Les données de l’appareil ont été retirées du hub IoT précédemment assigné, « reprovisionedToInitialAssignment » : L’appareil a été re-provisionné vers un hub IoT précédemment assigné.
symmetricKey	SymmetricKeyRegistrationResult	Résultat d’enregistrement renvoyé lors de l’utilisation de l’attestation SymmetricKey.
tpm	TpmRegistrationResult	Résultat de l’enregistrement TPM.
x509	X509RegistrationResult	Résultat de l’immatriculation X509.

EnrollmentStatus

Énumération

Statut d’inscription.

Valeur	Description
unassigned	unassigned
assigning	Attribution
assigned	les données assignées
failed	a échoué
disabled	disabled

ProvisioningServiceErrorDetails

Objet

Contient les propriétés d’une erreur retournée par le service de provisionnement Azure IoT Hub.

Nom	Type	Description
errorCode	integer (int32)	Code d’erreur numérique.
info	object	Dictionnaire de <chaîne>
message	string	Message d’erreur.
timestampUtc	string (date-time)	Horodatage d’erreur (UTC).
trackingId	string	ID de suivi d’erreurs.

SymmetricKeyRegistrationResult

Objet

Résultat d’enregistrement renvoyé lors de l’utilisation de l’attestation SymmetricKey.

Nom	Type	Description
enrollmentGroupId	string	ID de groupe d’inscription.

TpmAttestation

Objet

Attestation via TPM.

Nom	Type	Description
endorsementKey	string	Clé de l’approbation de TPM.
storageRootKey	string	Clé racine de stockage TPM.

TpmRegistrationResult

Objet

Résultat de l’enregistrement TPM.

Nom	Type	Description
authenticationKey	string	Clé d’authentification chiffrée.

X509CertificateInfo

Objet

Informations sur le certificat X509.

Nom	Type	Description
issuerName	string	Nom de l’émetteur du certificat.
notAfterUtc	string (date-time)	Date d’expiration du certificat (UTC).
notBeforeUtc	string (date-time)	Date de début de validité du certificat (UTC).
serialNumber	string	Numéro de série du certificat.
sha1Thumbprint	string	Empreinte digitale SHA-1 du certificat.
sha256Thumbprint	string	Empreinte digitale SHA-256 du certificat.
subjectName	string	Nom du sujet du certificat.
version	integer (int32)	Version du certificat.

X509RegistrationResult

Objet

Résultat de l’immatriculation X509.

Nom	Type	Description
certificateInfo	X509CertificateInfo	Informations sur le certificat X509.
enrollmentGroupId	string	ID de groupe d’inscription.
signingCertificateInfo	X509CertificateInfo	Informations sur le certificat X509.