Runtime Registration - Register Device

  • Referens
Tjänst:
IoT Hub Device Provisioning Service
API-version:
2021-10-01

Registrerar enheterna.

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

URI-parametrar

Name I Obligatorisk Typ Description
idScope
 path True

string

registrationId
 path True

string

Registrerings-ID:t är alfanumeriskt, gemener och kan innehålla bindestreck.
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ägesokä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

RegistrationOperationStatus

Klart
202 Accepted

RegistrationOperationStatus

Har godkänts

Sidhuvuden

  • Location: string
  • retry-after: integer
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.
RegistrationOperationStatus

Status för registreringsåtgärden.
SymmetricKeyRegistrationResult

Registreringsresultatet returnerades när SymmetricKey-attesteringen används.
TpmAttestation

Attestering via TPM.
TpmRegistrationResult

TPM-registreringsresultat.
X509CertificateInfo

X509-certifikatinformation.
X509RegistrationResult

X509-registreringsresultat.

DeviceRegistration

Enhetsregistrering.

Name Typ Description
payload

object

registrationId

string

Registrerings-ID:t är en skiftlägesokä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

Resultat av enhetsregistrering.

Name Typ Description
assignedHub

string

Tilldelade Azure IoT Hub.
createdDateTimeUtc

string

Registrering skapa datumtid (i UTC).
deviceId

string

Enhets-ID.
errorCode

integer

Felkod.
errorMessage

string

Felmeddelande.
etag

string

Entitetstaggen som är associerad med resursen.
lastUpdatedDateTimeUtc

string

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ägesokä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 togs 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 ometablerats till en tidigare tilldelad IoT-hubb.
symmetricKey

SymmetricKeyRegistrationResult

Registreringsresultatet returnerades när SymmetricKey-attesteringen används.
tpm

TpmRegistrationResult

TPM-registreringsresultat.
x509

X509RegistrationResult

X509-registreringsresultat.

ProvisioningServiceErrorDetails

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

Name Typ Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

RegistrationOperationStatus

Status för registreringsåtgärden.

Name Typ Description
operationId

string

Åtgärds-ID.
registrationState

DeviceRegistrationResult

Resultat av enhetsregistrering.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Status för enhetsregistrering.

SymmetricKeyRegistrationResult

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

Name Typ Description
enrollmentGroupId

string

TpmAttestation

Attestering via TPM.

Name Typ Description
endorsementKey

string

storageRootKey

string

TpmRegistrationResult

TPM-registreringsresultat.

Name Typ Description
authenticationKey

string

Krypterad autentiseringsnyckel.

X509CertificateInfo

X509-certifikatinformation.

Name Typ Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509RegistrationResult

X509-registreringsresultat.

Name Typ Description
certificateInfo

X509CertificateInfo

X509-certifikatinformation.
enrollmentGroupId

string

signingCertificateInfo

X509CertificateInfo

X509-certifikatinformation.