Sdílet prostřednictvím

Runtime Registration - Register Device

  • Reference
Služba:
IoT Hub Device Provisioning Service
Verze rozhraní API:
2021-10-01

Zaregistruje zařízení.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
idScope
 path True

string

registrationId
 path True

string

ID registrace je alfanumerické, malé a může obsahovat spojovníky.
api-version
 query True

string

Verze rozhraní API, která se má použít pro požadavek. Mezi podporované verze patří: 2021-10-01

Text požadavku

Name Typ Description
payload

object

registrationId

string

ID registrace je řetězec alfanumerických znaků nerozlišující velká a malá písmena (dlouhý až 128 znaků) plus určité speciální znaky: . _ -. Na začátku ani na konci nejsou povolené žádné speciální znaky.
tpm

TpmAttestation

Ověření identity prostřednictvím čipu TPM.

Odpovědi

Name Typ Description
200 OK

RegistrationOperationStatus

Success
202 Accepted

RegistrationOperationStatus

Přijato

Hlavičky

  • Location: string
  • retry-after: integer
Other Status Codes

ProvisioningServiceErrorDetails

Odpověď na chybu

Hlavičky

x-ms-error-code: string

Definice

Name Description
DeviceRegistration

Registrace zařízení.
DeviceRegistrationResult

Výsledek registrace zařízení.
ProvisioningServiceErrorDetails

Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning.
RegistrationOperationStatus

Stav operace registrace.
SymmetricKeyRegistrationResult

Výsledek registrace vrácený při použití ověření identity SymmetricKey
TpmAttestation

Ověření identity prostřednictvím čipu TPM.
TpmRegistrationResult

Výsledek registrace čipu TPM.
X509CertificateInfo

Informace o certifikátu X509
X509RegistrationResult

Výsledek registrace X509.

DeviceRegistration

Registrace zařízení.

Name Typ Description
payload

object

registrationId

string

ID registrace je řetězec alfanumerických znaků nerozlišující velká a malá písmena (dlouhý až 128 znaků) plus určité speciální znaky: . _ -. Na začátku ani na konci nejsou povolené žádné speciální znaky.
tpm

TpmAttestation

Ověření identity prostřednictvím čipu TPM.

DeviceRegistrationResult

Výsledek registrace zařízení.

Name Typ Description
assignedHub

string

Přiřazeno Azure IoT Hub.
createdDateTimeUtc

string

Registrace vytvoří datum a čas (v UTC).
deviceId

string

ID zařízení.
errorCode

integer

Kód chyby
errorMessage

string

Chybová zpráva.
etag

string

Značka entity přidružená k prostředku.
lastUpdatedDateTimeUtc

string

Datum poslední aktualizace (v UTC)
payload

object

registrationId

string

Toto ID slouží k jedinečné identifikaci registrace zařízení. Řetězec alfanumerických znaků nerozlišující velká a malá písmena (dlouhý až 128 znaků) plus určité speciální znaky: . _ -. Na začátku ani na konci nejsou povolené žádné speciální znaky.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Stav registrace.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Dílčí stav pro přiřazená zařízení. Mezi možné hodnoty patří initialAssignment: Zařízení bylo poprvé přiřazeno ke službě IoT Hub, deviceDataMigrated: Zařízení bylo přiřazeno k jinému centru IoT a data zařízení se migrovala z dříve přiřazeného centra IoT. Data zařízení byla odebrána z dříve přiřazeného centra IoT, deviceDataReset: Zařízení bylo přiřazeno k jinému centru IoT a jeho data zařízení se naplnila z počátečního stavu uloženého v registraci. Data zařízení byla odebrána z dříve přiřazeného centra IoT, reprovisionedToInitialAssignment: Zařízení bylo znovu zřízeno na dříve přiřazené centrum IoT.
symmetricKey

SymmetricKeyRegistrationResult

Výsledek registrace vrácený při použití ověření identity SymmetricKey
tpm

TpmRegistrationResult

Výsledek registrace čipu TPM.
x509

X509RegistrationResult

Výsledek registrace X509.

ProvisioningServiceErrorDetails

Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning.

Name Typ Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

RegistrationOperationStatus

Stav operace registrace.

Name Typ Description
operationId

string

ID operace.
registrationState

DeviceRegistrationResult

Výsledek registrace zařízení.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Stav registrace zařízení.

SymmetricKeyRegistrationResult

Výsledek registrace vrácený při použití ověření identity SymmetricKey

Name Typ Description
enrollmentGroupId

string

TpmAttestation

Ověření identity prostřednictvím čipu TPM.

Name Typ Description
endorsementKey

string

storageRootKey

string

TpmRegistrationResult

Výsledek registrace čipu TPM.

Name Typ Description
authenticationKey

string

Šifrovaný ověřovací klíč.

X509CertificateInfo

Informace o certifikátu X509

Name Typ Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509RegistrationResult

Výsledek registrace X509.

Name Typ Description
certificateInfo

X509CertificateInfo

Informace o certifikátu X509
enrollmentGroupId

string

signingCertificateInfo

X509CertificateInfo

Informace o certifikátu X509