Runtime Registration - Device Registration Status Lookup

Szolgáltatás:
IoT Hub Device Provisioning Service
API-verzió:
2021-10-01

Megkapja az eszköz regisztrációs státuszát.

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

URI-paraméterek

Name In Kötelező Típus Description
idScope
 path True

string

A DPS példány hatóköre.
registrationId
 path True

string

Regisztrációs azonosító.
api-version
 query True

string

minLength: 1

A művelethez használandó API-verzió.

Kérelem törzse

Name Típus Description
payload

Bármely objektum
registrationId

string

A regisztrációs azonosító egy kis- és nagybetűs (legfeljebb 128 karakter hosszú) betűs, valamint bizonyos speciális karakterek : . _ -. A kezdő vagy a végén nem engedélyezett speciális karakterek.
tpm

TpmAttestation

Hitelesítés TPM-en keresztül.

Válaszok

Name Típus Description
200 OK

DeviceRegistrationResult

A kérés sikeres volt.
Other Status Codes

ProvisioningServiceErrorDetails

Váratlan hibaválasz.

Fejlécek

x-ms-error-code: string

Példák

RuntimeRegistration_DeviceRegistrationStatusLookup_MaximumSet_Gen
RuntimeRegistration_DeviceRegistrationStatusLookup_MinimumSet_Gen

RuntimeRegistration_DeviceRegistrationStatusLookup_MaximumSet_Gen

Mintakérelem

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

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

Mintaválasz

Állapotkód:
200 
{
  "assignedHub": "ljexps",
  "createdDateTimeUtc": "2025-10-01T17:41:56.535Z",
  "deviceId": "hjvdlwpugzlk",
  "errorCode": 13,
  "errorMessage": "zpctqazbkbiqjkwosis",
  "etag": "hjtelksspyfzhmet",
  "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

Mintakérelem

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

{}

Mintaválasz

Állapotkód:
200 
{}

Definíciók

Name Description
AssignedDeviceSubstatus

Alstátusz a 'Hozzárendelt' eszközökhöz. Lehetséges értékek a következők: 'initialAssignment': Az eszközt először rendelték IoT hubhoz, 'deviceDataMigrated': Az eszközt egy másik IoT hubhoz rendelték, és az eszköz adatait a korábban kijelölt IoT hubról migrálták. Az eszközadatokat eltávolították a korábban kijelölt IoT hubról, a 'deviceDataReset'-ről: Az eszközt egy másik IoT hubhoz rendelték, és az eszköz adatai a regisztrációban tárolt eredeti állapotból lettek feltöltve. Az eszköz adatait eltávolították a korábban kijelölt IoT hubról, a 'reprovisionedToInitialAssignment'-ről: Az eszközt újra felállították egy korábban kijelölt IoT hubra.
DeviceRegistration

Eszköz regisztrációja
DeviceRegistrationResult

Eszköz regisztrációs eredmény.
EnrollmentStatus

Regisztrációs állapot.
ProvisioningServiceErrorDetails

Tartalmazza az Azure IoT Hub Provisioning Service által visszaadott hiba tulajdonságait.
SymmetricKeyRegistrationResult

A regisztrációs eredmény megjelent SymmetricKey hitelesítés használatakor.
TpmAttestation

Hitelesítés TPM-en keresztül.
TpmRegistrationResult

TPM regisztrációs eredmény.
X509CertificateInfo

X509 tanúsítvány információ.
X509RegistrationResult

X509 regisztrációs eredmény.

AssignedDeviceSubstatus

Felsorolás

Alstátusz a 'Hozzárendelt' eszközökhöz. Lehetséges értékek a következők: 'initialAssignment': Az eszközt először rendelték IoT hubhoz, 'deviceDataMigrated': Az eszközt egy másik IoT hubhoz rendelték, és az eszköz adatait a korábban kijelölt IoT hubról migrálták. Az eszközadatokat eltávolították a korábban kijelölt IoT hubról, a 'deviceDataReset'-ről: Az eszközt egy másik IoT hubhoz rendelték, és az eszköz adatai a regisztrációban tárolt eredeti állapotból lettek feltöltve. Az eszköz adatait eltávolították a korábban kijelölt IoT hubról, a 'reprovisionedToInitialAssignment'-ről: Az eszközt újra felállították egy korábban kijelölt IoT hubra.

Érték Description
initialAssignment

kezdeti kiosztás
deviceDataMigrated

deviceDataMigrated
deviceDataReset

deviceDataReset
reprovisionedToInitialAssignment

reprovisionedToInitial Assignment

DeviceRegistration

Tárgy

Eszköz regisztrációja

Name Típus Description
payload

Bármely objektum
registrationId

string

A regisztrációs azonosító egy kis- és nagybetűs (legfeljebb 128 karakter hosszú) betűs, valamint bizonyos speciális karakterek : . _ -. A kezdő vagy a végén nem engedélyezett speciális karakterek.
tpm

TpmAttestation

Hitelesítés TPM-en keresztül.

DeviceRegistrationResult

Tárgy

Eszköz regisztrációs eredmény.

Name Típus Description
assignedHub

string

Assigned Azure IoT Hub.
createdDateTimeUtc

string (date-time)

Regisztráció dátum létrehozása időpont (UTC-ben).
deviceId

string

Eszközazonosító.
errorCode

integer (int32)

Hibakód.
errorMessage

string

Hibaüzenet.
etag

string

Az erőforráshoz tartozó entitáscímké.
lastUpdatedDateTimeUtc

string (date-time)

Utoljára frissített dátum (UTC-ben).
payload

Bármely objektum
registrationId

string

Ezt az azonosítót egyediben arra használják, hogy egyediben azonosítsák a regisztrációs eszközregisztrációt. Egy kis- és nagybetűs láncsor, amely akár 128 karakter hosszú, alfanumerikus karakterekből és bizonyos speciális karakterekből áll: . _ -. A kezdő vagy a végén nem engedélyezett speciális karakterek.
status

EnrollmentStatus

Regisztrációs állapot.
substatus

AssignedDeviceSubstatus

Alstátusz a 'Hozzárendelt' eszközökhöz. Lehetséges értékek a következők: 'initialAssignment': Az eszközt először rendelték IoT hubhoz, 'deviceDataMigrated': Az eszközt egy másik IoT hubhoz rendelték, és az eszköz adatait a korábban kijelölt IoT hubról migrálták. Az eszközadatokat eltávolították a korábban kijelölt IoT hubról, a 'deviceDataReset'-ről: Az eszközt egy másik IoT hubhoz rendelték, és az eszköz adatai a regisztrációban tárolt eredeti állapotból lettek feltöltve. Az eszköz adatait eltávolították a korábban kijelölt IoT hubról, a 'reprovisionedToInitialAssignment'-ről: Az eszközt újra felállították egy korábban kijelölt IoT hubra.
symmetricKey

SymmetricKeyRegistrationResult

A regisztrációs eredmény megjelent SymmetricKey hitelesítés használatakor.
tpm

TpmRegistrationResult

TPM regisztrációs eredmény.
x509

X509RegistrationResult

X509 regisztrációs eredmény.

EnrollmentStatus

Felsorolás

Regisztrációs állapot.

Érték Description
unassigned

nincs hozzárendelve
assigning

Hozzárendelés
assigned

Hozzárendelt
failed

sikertelen
disabled

halványított

ProvisioningServiceErrorDetails

Tárgy

Tartalmazza az Azure IoT Hub Provisioning Service által visszaadott hiba tulajdonságait.

Name Típus Description
errorCode

integer (int32)

Numerikus hibakód.
info

object

<sztring> szótára
message

string

Hibaüzenet.
timestampUtc

string (date-time)

Hiba időbélyeg (UTC).
trackingId

string

Hibakövetési azonosító.

SymmetricKeyRegistrationResult

Tárgy

A regisztrációs eredmény megjelent SymmetricKey hitelesítés használatakor.

Name Típus Description
enrollmentGroupId

string

Regisztrációs csoport azonosítója.

TpmAttestation

Tárgy

Hitelesítés TPM-en keresztül.

Name Típus Description
endorsementKey

string

TPM támogatási kulcs.
storageRootKey

string

TPM tároló gyökérkulcs.

TpmRegistrationResult

Tárgy

TPM regisztrációs eredmény.

Name Típus Description
authenticationKey

string

Titkosított hitelesítési kulcs.

X509CertificateInfo

Tárgy

X509 tanúsítvány információ.

Name Típus Description
issuerName

string

Tanúsítványkibocsátó neve.
notAfterUtc

string (date-time)

Tanúsítvány lejárati dátuma (UTC).
notBeforeUtc

string (date-time)

Tanúsítvány érvényességi kezdeti dátuma (UTC).
serialNumber

string

Tanúsítvány sorozatszám.
sha1Thumbprint

string

SHA-1 ujjlenyomatot a tanúsítványról.
sha256Thumbprint

string

SHA-256 ujjlenyomatot a bizonyítványról.
subjectName

string

Bizonyítvány tárgy neve.
version

integer (int32)

Tanúsítvány verziója.

X509RegistrationResult

Tárgy

X509 regisztrációs eredmény.

Name Típus Description
certificateInfo

X509CertificateInfo

X509 tanúsítvány információ.
enrollmentGroupId

string

Regisztrációs csoport azonosítója.
signingCertificateInfo

X509CertificateInfo

X509 tanúsítvány információ.