Runtime Registration - Register Device

Služba:: IoT Hub Device Provisioning Service

Verze rozhraní API:: 2021-10-01

Registruje 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	Rozsah instance DPS.
registrationId	path	True	string	Registrační ID je alfanumerické, malé písmeno a může obsahovat pomlčky.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
payload		Libovolný objekt
registrationId	string	Registrační ID je řetězec bez rozlišování na velikost písmen (až 128 znaků dlouhý) alfanumerických znaků plus určitých speciálních znaků : . _ -. Na začátku ani na konci nejsou povoleny žádné speciální postavy.
tpm	TpmAttestation	Ověření přes TPM.

Odpovědi

Name	Typ	Description
200 OK	RegistrationOperationStatus	Požadavek byl úspěšný.
202 Accepted	RegistrationOperationStatus	Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno. Hlavičky Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

RegistrationOperationStatus

Požadavek byl úspěšný.

202 Accepted

RegistrationOperationStatus

Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno.

Hlavičky

Location: string
retry-after: integer

Other Status Codes

ProvisioningServiceErrorDetails

Neočekávaná chybová odpověď

Hlavičky

x-ms-error-code: string

Příklady

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

RuntimeRegistration_RegisterDevice_MinimumSet_Gen

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

Ukázkový požadavek

HTTP

PUT https://global.azure-devices-provisioning.net/ofvgihmgllfsmm/registrations/macgmlbhpb/register?api-version=2021-10-01

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

Ukázková odpověď

Stavový kód:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi",
  "registrationState": {
    "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
      }
    }
  },
  "status": "unassigned"
}

Stavový kód:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi",
  "registrationState": {
    "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
      }
    }
  },
  "status": "unassigned"
}

RuntimeRegistration_RegisterDevice_MinimumSet_Gen

Ukázkový požadavek

HTTP

PUT https://global.azure-devices-provisioning.net/gwgyqmyyzzzjpjmxml/registrations/tuodrxicixbbekaajxfiyvoxsbe/register?api-version=2021-10-01

{}

Ukázková odpověď

Stavový kód:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Stavový kód:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Definice

Name	Description
AssignedDeviceSubstatus	Podstav pro 'přiřazená' zařízení. Možné hodnoty zahrnují - 'initialAssignment': Zařízení bylo poprvé přiřazeno k IoT hubu, 'deviceDataMigrated': Zařízení bylo přiřazeno k jinému IoT hubu a jeho data byla migrována z dříve přiděleného IoT hubu. Data zařízení byla odstraněna z dříve přiděleného IoT hubu, 'deviceDataReset': Zařízení bylo přiřazeno k jinému IoT hubu a jeho data byla načtena z původního stavu uloženého v registraci. Data zařízení byla odstraněna z dříve přiděleného IoT hubu, 'reprovisionedToInitialAssignment': Zařízení bylo znovu provisionováno do dříve přiděleného IoT hubu.
DeviceRegistration	Registrace zařízení.
DeviceRegistrationResult	Výsledek registrace zařízení.
EnrollmentStatus	Stav zápisu.
ProvisioningServiceErrorDetails	Obsahuje vlastnosti chyby vrácené službou Azure IoT Hub Provisioning.
RegistrationOperationStatus	Stav registrační operace.
SymmetricKeyRegistrationResult	Výsledek registrace se vrátil při použití attestace SymmetricKey.
TpmAttestation	Ověření přes TPM.
TpmRegistrationResult	Výsledek registrace TPM.
X509CertificateInfo	Informace o certifikátu X509.
X509RegistrationResult	Výsledek registrace X509.

AssignedDeviceSubstatus

Výčet

Podstav pro 'přiřazená' zařízení. Možné hodnoty zahrnují - 'initialAssignment': Zařízení bylo poprvé přiřazeno k IoT hubu, 'deviceDataMigrated': Zařízení bylo přiřazeno k jinému IoT hubu a jeho data byla migrována z dříve přiděleného IoT hubu. Data zařízení byla odstraněna z dříve přiděleného IoT hubu, 'deviceDataReset': Zařízení bylo přiřazeno k jinému IoT hubu a jeho data byla načtena z původního stavu uloženého v registraci. Data zařízení byla odstraněna z dříve přiděleného IoT hubu, 'reprovisionedToInitialAssignment': Zařízení bylo znovu provisionováno do dříve přiděleného IoT hubu.

Hodnota	Description
initialAssignment	initialAssignment
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionedToInitialAssignment

DeviceRegistration

Objekt

Registrace zařízení.

Name	Typ	Description
payload		Libovolný objekt
registrationId	string	Registrační ID je řetězec bez rozlišování na velikost písmen (až 128 znaků dlouhý) alfanumerických znaků plus určitých speciálních znaků : . _ -. Na začátku ani na konci nejsou povoleny žádné speciální postavy.
tpm	TpmAttestation	Ověření přes TPM.

DeviceRegistrationResult

Objekt

Výsledek registrace zařízení.

Name	Typ	Description
assignedHub	string	Přiřazen Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Registrace – datum vytvoření (v UTC).
deviceId	string	ID zařízení.
errorCode	integer (int32)	Kód chyby
errorMessage	string	Chybová zpráva.
etag	string	Tag entity přiřazený ke zdroji.
lastUpdatedDateTimeUtc	string (date-time)	Poslední aktualizace data a čas (v UTC).
payload		Libovolný objekt
registrationId	string	Toto ID se používá k jednoznačné identifikaci registrace zařízení. Řetězec bez velikosti (až 128 znaků dlouhý) alfanumerických znaků plus určitých speciálních znaků : . _ -. Na začátku ani na konci nejsou povoleny žádné speciální postavy.
status	EnrollmentStatus	Stav zápisu.
substatus	AssignedDeviceSubstatus	Podstav pro 'přiřazená' zařízení. Možné hodnoty zahrnují - 'initialAssignment': Zařízení bylo poprvé přiřazeno k IoT hubu, 'deviceDataMigrated': Zařízení bylo přiřazeno k jinému IoT hubu a jeho data byla migrována z dříve přiděleného IoT hubu. Data zařízení byla odstraněna z dříve přiděleného IoT hubu, 'deviceDataReset': Zařízení bylo přiřazeno k jinému IoT hubu a jeho data byla načtena z původního stavu uloženého v registraci. Data zařízení byla odstraněna z dříve přiděleného IoT hubu, 'reprovisionedToInitialAssignment': Zařízení bylo znovu provisionováno do dříve přiděleného IoT hubu.
symmetricKey	SymmetricKeyRegistrationResult	Výsledek registrace se vrátil při použití attestace SymmetricKey.
tpm	TpmRegistrationResult	Výsledek registrace TPM.
x509	X509RegistrationResult	Výsledek registrace X509.

EnrollmentStatus

Výčet

Stav zápisu.

Hodnota	Description
unassigned	Nepřiřazené
assigning	Přiřazení
assigned	přiřazený
failed	selhalo
disabled	neaktivní

ProvisioningServiceErrorDetails

Objekt

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

Name	Typ	Description
errorCode	integer (int32)	Číselný kód chyby
info	object	Slovník řetězce <>
message	string	Chybová zpráva.
timestampUtc	string (date-time)	Časové razítko chyby (UTC).
trackingId	string	ID sledování chyb.

RegistrationOperationStatus

Objekt

Stav registrační operace.

Name	Typ	Description
operationId	string minLength: 1	Identifikační číslo operace.
registrationState	DeviceRegistrationResult	Výsledek registrace zařízení.
status	EnrollmentStatus	Stav registrace zařízení.

SymmetricKeyRegistrationResult

Objekt

Výsledek registrace se vrátil při použití attestace SymmetricKey.

Name	Typ	Description
enrollmentGroupId	string	ID skupiny registrací

TpmAttestation

Objekt

Ověření přes TPM.

Name	Typ	Description
endorsementKey	string	TPM klíč k schválení.
storageRootKey	string	TPM úložiště root klíč.

TpmRegistrationResult

Objekt

Výsledek registrace TPM.

Name	Typ	Description
authenticationKey	string	Šifrovaný autentizační klíč.

X509CertificateInfo

Objekt

Informace o certifikátu X509.

Name	Typ	Description
issuerName	string	Název vystavitele certifikátu
notAfterUtc	string (date-time)	Datum expirace certifikátu (UTC).
notBeforeUtc	string (date-time)	Platnost certifikátu – datum začátku (UTC).
serialNumber	string	Sériové číslo certifikátu.
sha1Thumbprint	string	Otisk palce SHA-1 certifikátu.
sha256Thumbprint	string	Otisk palce SHA-256 na certifikátu.
subjectName	string	Název předmětu certifikátu.
version	integer (int32)	Verze certifikátu.

X509RegistrationResult

Objekt

Výsledek registrace X509.

Name	Typ	Description
certificateInfo	X509CertificateInfo	Informace o certifikátu X509.
enrollmentGroupId	string	ID skupiny registrací
signingCertificateInfo	X509CertificateInfo	Informace o certifikátu X509.