Runtime Registration - Device Registration Status Lookup

Service:

IoT Hub Device Provisioning Service

API Version:

2021-10-01

Lekéri az eszközregisztrációs állapotot.

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
registrationId	path	True	string	Regisztrációs azonosító.
api-version	query	True	string	A kéréshez használni kívánt API-verzió. Támogatott verziók: 2021.10.01.

Kérelem törzse

Name	Típus	Description
payload	object
registrationId	string	A regisztrációs azonosító egy kis- és nagybetűket nem megkülönböztető sztring (legfeljebb 128 karakter hosszú) alfanumerikus karakterekből és bizonyos speciális karakterekből: . _ -. A kezdéskor és a végén nem engedélyezett speciális karakterek használata.
tpm	TpmAttestation	Igazolás TPM-en keresztül.

Válaszok

Name	Típus	Description
200 OK	DeviceRegistrationResult	Siker
Other Status Codes	ProvisioningServiceErrorDetails	Hibaválasz Headers x-ms-error-code: string

Definíciók

Name	Description
DeviceRegistration	Eszközregisztráció.
DeviceRegistrationResult	Eszközregisztrációs eredmény.
ProvisioningServiceErrorDetails	A Azure IoT Hub kiépítési szolgáltatás által visszaadott hiba tulajdonságait tartalmazza.
SymmetricKeyRegistrationResult	A symmetricKey igazolás használatakor visszaadott regisztrációs eredmény.
TpmAttestation	Igazolás TPM-en keresztül.
TpmRegistrationResult	TPM-regisztráció eredménye.
X509CertificateInfo	X509-tanúsítvány adatai.
X509RegistrationResult	X509 regisztrációs eredmény.

DeviceRegistration

Eszközregisztráció.

Name	Típus	Description
payload	object
registrationId	string	A regisztrációs azonosító egy kis- és nagybetűket nem megkülönböztető sztring (legfeljebb 128 karakter hosszú) alfanumerikus karakterekből és bizonyos speciális karakterekből: . _ -. A kezdéskor és a végén nem engedélyezett speciális karakterek használata.
tpm	TpmAttestation	Igazolás TPM-en keresztül.

DeviceRegistrationResult

Eszközregisztrációs eredmény.

Name	Típus	Description
assignedHub	string	Hozzárendelt Azure IoT Hub.
createdDateTimeUtc	string	A regisztráció dátum-létrehozási időpontja (UTC-ben).
deviceId	string	Eszközazonosító.
errorCode	integer	Hibakód.
errorMessage	string	Hibaüzenet.
etag	string	Az erőforráshoz társított entitáscímke.
lastUpdatedDateTimeUtc	string	Utolsó frissítés dátuma (UTC-ben).
payload	object
registrationId	string	Ez az azonosító egy regisztráció eszközregisztrációjának egyedi azonosítására szolgál. Kis- és nagybetűk megkülönböztetése (legfeljebb 128 karakter hosszú) alfanumerikus karakterekből és bizonyos speciális karakterekből: . _ -. A kezdéskor és a végén nem engedélyezett speciális karakterek használata.
status	enum: assigned assigning disabled failed unassigned	Regisztráció állapota.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	"Hozzárendelt" eszközök alállapota. Lehetséges értékek: - 'initialAssignment': Az eszköz első alkalommal lett hozzárendelve egy IoT Hubhoz(deviceDataMigrated): Az eszköz egy másik IoT Hubhoz lett hozzárendelve, és az eszköz adatai át lettek migrálva a korábban hozzárendelt IoT Hubról. Az eszközadatok el lettek távolítva a korábban hozzárendelt IoT Hubból( deviceDataReset): Az eszköz egy másik IoT Hubhoz lett hozzárendelve, és az eszköz adatai a regisztrációban tárolt kezdeti állapotból lettek feltöltve. Az eszköz adatai el lettek távolítva a korábban hozzárendelt IoT Hubról, a "reprovisionedToInitialAssignment" szolgáltatásból: Az eszközt újra kiépítették egy korábban hozzárendelt IoT Hubra.
symmetricKey	SymmetricKeyRegistrationResult	A symmetricKey igazolás használatakor visszaadott regisztrációs eredmény.
tpm	TpmRegistrationResult	TPM-regisztráció eredménye.
x509	X509RegistrationResult	X509 regisztrációs eredmény.

ProvisioningServiceErrorDetails

A Azure IoT Hub kiépítési szolgáltatás által visszaadott hiba tulajdonságait tartalmazza.

Name	Típus	Description
errorCode	integer
info	object
message	string
timestampUtc	string
trackingId	string

SymmetricKeyRegistrationResult

A symmetricKey igazolás használatakor visszaadott regisztrációs eredmény.

Name	Típus	Description
enrollmentGroupId	string

TpmAttestation

Igazolás TPM-en keresztül.

Name	Típus	Description
endorsementKey	string
storageRootKey	string

TpmRegistrationResult

TPM-regisztráció eredménye.

Name	Típus	Description
authenticationKey	string	Titkosított hitelesítési kulcs.

X509CertificateInfo

X509-tanúsítvány adatai.

Name	Típus	Description
issuerName	string
notAfterUtc	string
notBeforeUtc	string
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer

X509RegistrationResult

X509 regisztrációs eredmény.

Name	Típus	Description
certificateInfo	X509CertificateInfo	X509-tanúsítvány adatai.
enrollmentGroupId	string
signingCertificateInfo	X509CertificateInfo	X509-tanúsítvány adatai.