Runtime Registration - Device Registration Status Lookup

Tjänst:: IoT Hub Device Provisioning Service

API-version:: 2021-10-01

Får enhetsregistreringsstatus.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
idScope	path	True	string	Omfattningen av DPS-instansen.
registrationId	path	True	string	Registrerings-ID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
payload		Alla objekt
registrationId	string	Registrerings-ID:t är en mellan- och mellanlägeskänslig sträng (upp till 128 tecken lång) av alfanumeriska tecken plus vissa specialtecken: . _ -. Inga specialtecken tillåtna i början eller slutet.
tpm	TpmAttestation	Intyg via TPM.

Svar

Name	Typ	Description
200 OK	DeviceRegistrationResult	Begäran har lyckats.
Other Status Codes	ProvisioningServiceErrorDetails	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

DeviceRegistrationResult

Begäran har lyckats.

Other Status Codes

ProvisioningServiceErrorDetails

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Exempel

RuntimeRegistration_DeviceRegistrationStatusLookup_MaximumSet_Gen

RuntimeRegistration_DeviceRegistrationStatusLookup_MinimumSet_Gen

RuntimeRegistration_DeviceRegistrationStatusLookup_MaximumSet_Gen

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:: 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

Exempelbegäran

HTTP

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

{}

Exempelsvar

Statuskod:: 200

{}

Definitioner

Name	Description
AssignedDeviceSubstatus	Substatus för 'Tilldelade' enheter. Möjliga värden inkluderar - 'initialAssignment': Enheten har tilldelats en IoT-hubb för första gången, 'deviceDataMigrated': Enheten har tilldelats en annan IoT-hubb och dess enhetsdata migrerades från den tidigare tilldelade IoT-hubben. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben, 'deviceDataReset': Enheten har tilldelats en annan IoT-hubb och dess enhetsdata fylldes i från det ursprungliga tillståndet som lagrats vid registreringen. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben, 'reprovisionedToInitialAssignment': Enheten har reprovisionerats till en tidigare tilldelad IoT-hubb.
DeviceRegistration	Enhetsregistrering.
DeviceRegistrationResult	Resultat för enhetsregistrering.
EnrollmentStatus	Registreringsstatus.
ProvisioningServiceErrorDetails	Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.
SymmetricKeyRegistrationResult	Registreringsresultatet returnerades vid användning av SymmetricKey-attestering.
TpmAttestation	Intyg via TPM.
TpmRegistrationResult	TPM-registreringsresultat.
X509CertificateInfo	X509-certifikatinformation.
X509RegistrationResult	Resultat på X509-registreringen.

AssignedDeviceSubstatus

Uppräkning

Substatus för 'Tilldelade' enheter. Möjliga värden inkluderar - 'initialAssignment': Enheten har tilldelats en IoT-hubb för första gången, 'deviceDataMigrated': Enheten har tilldelats en annan IoT-hubb och dess enhetsdata migrerades från den tidigare tilldelade IoT-hubben. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben, 'deviceDataReset': Enheten har tilldelats en annan IoT-hubb och dess enhetsdata fylldes i från det ursprungliga tillståndet som lagrats vid registreringen. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben, 'reprovisionedToInitialAssignment': Enheten har reprovisionerats till en tidigare tilldelad IoT-hubb.

Värde	Description
initialAssignment	Initialt Tilldelning
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionedToInitialAssignment

DeviceRegistration

Objekt

Enhetsregistrering.

Name	Typ	Description
payload		Alla objekt
registrationId	string	Registrerings-ID:t är en mellan- och mellanlägeskänslig sträng (upp till 128 tecken lång) av alfanumeriska tecken plus vissa specialtecken: . _ -. Inga specialtecken tillåtna i början eller slutet.
tpm	TpmAttestation	Intyg via TPM.

DeviceRegistrationResult

Objekt

Resultat för enhetsregistrering.

Name	Typ	Description
assignedHub	string	Assigned Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Registrering, skapa datum, tid (i UTC).
deviceId	string	Enhets-ID.
errorCode	integer (int32)	Felkod.
errorMessage	string	Felmeddelande.
etag	string	Entitetstaggen som är kopplad till resursen.
lastUpdatedDateTimeUtc	string (date-time)	Senast uppdaterat datum, tid (i UTC).
payload		Alla objekt
registrationId	string	Detta id används för att unikt identifiera en enhetsregistrering av en registrering. En mellanlägesinsensitiv sträng (upp till 128 tecken lång) av alfanumeriska tecken plus vissa specialtecken : . _ -. Inga specialtecken tillåtna i början eller slutet.
status	EnrollmentStatus	Registreringsstatus.
substatus	AssignedDeviceSubstatus	Substatus för 'Tilldelade' enheter. Möjliga värden inkluderar - 'initialAssignment': Enheten har tilldelats en IoT-hubb för första gången, 'deviceDataMigrated': Enheten har tilldelats en annan IoT-hubb och dess enhetsdata migrerades från den tidigare tilldelade IoT-hubben. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben, 'deviceDataReset': Enheten har tilldelats en annan IoT-hubb och dess enhetsdata fylldes i från det ursprungliga tillståndet som lagrats vid registreringen. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben, 'reprovisionedToInitialAssignment': Enheten har reprovisionerats till en tidigare tilldelad IoT-hubb.
symmetricKey	SymmetricKeyRegistrationResult	Registreringsresultatet returnerades vid användning av SymmetricKey-attestering.
tpm	TpmRegistrationResult	TPM-registreringsresultat.
x509	X509RegistrationResult	Resultat på X509-registreringen.

EnrollmentStatus

Uppräkning

Registreringsstatus.

Värde	Description
unassigned	Otilldelade
assigning	Tilldelning
assigned	tilldelad
failed	Misslyckades
disabled	funktionshindrad

ProvisioningServiceErrorDetails

Objekt

Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.

Name	Typ	Description
errorCode	integer (int32)	Numerisk felkod.
info	object	Ordlista för <sträng>
message	string	Felmeddelande.
timestampUtc	string (date-time)	Feltidsstämpel (UTC).
trackingId	string	Felspårnings-ID.

SymmetricKeyRegistrationResult

Objekt

Registreringsresultatet returnerades vid användning av SymmetricKey-attestering.

Name	Typ	Description
enrollmentGroupId	string	Registreringsgrupp-ID.

TpmAttestation

Objekt

Intyg via TPM.

Name	Typ	Description
endorsementKey	string	TPM-godkännandenyckel.
storageRootKey	string	TPM-lagringsrotnyckel.

TpmRegistrationResult

Objekt

TPM-registreringsresultat.

Name	Typ	Description
authenticationKey	string	Krypterad autentiseringsnyckel.

X509CertificateInfo

Objekt

X509-certifikatinformation.

Name	Typ	Description
issuerName	string	Certifikatutfärdarnamn.
notAfterUtc	string (date-time)	Certifikatets utgångsdatum (UTC).
notBeforeUtc	string (date-time)	Giltighetsdatum för certifikatets gäldlingsdatum (UTC).
serialNumber	string	Certifikatets serienummer.
sha1Thumbprint	string	SHA-1 tumavtryck av certifikatet.
sha256Thumbprint	string	SHA-256 tumavtryck av certifikatet.
subjectName	string	Ämnesnamn på certifikatet.
version	integer (int32)	Certifikatversion.

X509RegistrationResult

Objekt

Resultat på X509-registreringen.

Name	Typ	Description
certificateInfo	X509CertificateInfo	X509-certifikatinformation.
enrollmentGroupId	string	Registreringsgrupp-ID.
signingCertificateInfo	X509CertificateInfo	X509-certifikatinformation.