Runtime Registration - Device Registration Status Lookup

Tjänst:

IoT Hub Device Provisioning Service

API-version:

2021-10-01

Hämtar status för enhetsregistrering.

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
registrationId	path	True	string	Registrerings-ID.
api-version	query	True	string	DEN API-version som ska användas för begäran. Versioner som stöds är: 2021-10-01

Begärandetext

Name	Typ	Description
payload	object
registrationId	string	Registrerings-ID:t är en skiftlägeskänslig sträng (upp till 128 tecken lång) med alfanumeriska tecken plus vissa specialtecken : . _ -. Inga specialtecken tillåts i början eller slutet.
tpm	TpmAttestation	Attestering via TPM.

Svar

Name	Typ	Description
200 OK	DeviceRegistrationResult	Framgång
Other Status Codes	ProvisioningServiceErrorDetails	Felsvar Sidhuvuden x-ms-error-code: string

Definitioner

Name	Description
DeviceRegistration	Enhetsregistrering.
DeviceRegistrationResult	Resultat av enhetsregistrering.
ProvisioningServiceErrorDetails	Innehåller egenskaperna för ett fel som returneras av Azure IoT Hub Provisioning Service.
SymmetricKeyRegistrationResult	Registreringsresultatet returnerades när SymmetricKey-attestering används.
TpmAttestation	Attestering via TPM.
TpmRegistrationResult	TPM-registreringsresultat.
X509CertificateInfo	X509-certifikatinformation.
X509RegistrationResult	X509-registreringsresultat.

DeviceRegistration

Objekt

Enhetsregistrering.

Name	Typ	Description
payload	object
registrationId	string	Registrerings-ID:t är en skiftlägeskänslig sträng (upp till 128 tecken lång) med alfanumeriska tecken plus vissa specialtecken : . _ -. Inga specialtecken tillåts i början eller slutet.
tpm	TpmAttestation	Attestering via TPM.

DeviceRegistrationResult

Objekt

Resultat av enhetsregistrering.

Name	Typ	Description
assignedHub	string	Tilldelad Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Registrering skapa datumtid (i UTC).
deviceId	string	Enhets-ID.
errorCode	integer (int32)	Felkod.
errorMessage	string	Felmeddelande.
etag	string	Entitetstaggen som är associerad med resursen.
lastUpdatedDateTimeUtc	string (date-time)	Senast uppdaterad datumtid (i UTC).
payload	object
registrationId	string	Det här ID:t används för att unikt identifiera en enhetsregistrering av en registrering. En skiftlägeskänslig sträng (upp till 128 tecken lång) med alfanumeriska tecken plus vissa specialtecken : . _ -. Inga specialtecken tillåts i början eller slutet.
status	enum: assigned assigning disabled failed unassigned	Registreringsstatus.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	Understatus för "Tilldelade" enheter. Möjliga värden är – "initialAssignment": Enheten har tilldelats till en IoT-hubb för första gången, "deviceDataMigrated": Enheten har tilldelats till en annan IoT-hubb och dess enhetsdata har migrerats från den tidigare tilldelade IoT-hubben. Enhetsdata har tagits bort från den tidigare tilldelade IoT-hubben deviceDataReset: Enheten har tilldelats till en annan IoT-hubb och dess enhetsdata fylldes i från det ursprungliga tillståndet som lagrades i registreringen. Enhetsdata togs bort från den tidigare tilldelade IoT-hubben , "reprovisionedToInitialAssignment": Enheten har återetablerats till en tidigare tilldelad IoT-hubb.
symmetricKey	SymmetricKeyRegistrationResult	Registreringsresultatet returnerades när SymmetricKey-attestering används.
tpm	TpmRegistrationResult	TPM-registreringsresultat.
x509	X509RegistrationResult	X509-registreringsresultat.

ProvisioningServiceErrorDetails

Objekt

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

Name	Typ	Description
errorCode	integer (int32)
info	object
message	string
timestampUtc	string (date-time)
trackingId	string

SymmetricKeyRegistrationResult

Objekt

Registreringsresultatet returnerades när SymmetricKey-attestering används.

Name	Typ	Description
enrollmentGroupId	string

TpmAttestation

Objekt

Attestering via TPM.

Name	Typ	Description
endorsementKey	string
storageRootKey	string

TpmRegistrationResult

Objekt

TPM-registreringsresultat.

Name	Typ	Description
authenticationKey	string	Krypterad autentiseringsnyckel.

X509CertificateInfo

Objekt

X509-certifikatinformation.

Name	Typ	Description
issuerName	string
notAfterUtc	string (date-time)
notBeforeUtc	string (date-time)
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer (int32)

X509RegistrationResult

Objekt

X509-registreringsresultat.

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