Runtime Registration - Register Device

Service:: IoT Hub Device Provisioning Service

API-versie:: 2021-10-01

Registreert de apparaten.

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

URI-parameters

Name	In	Vereist	Type	Description
idScope	path	True	string	De reikwijdte van de DPS-instantie.
registrationId	path	True	string	De registratie-ID is alfanumeriek, met kleine letters en kan koppeltekens bevatten.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
payload		Elk object
registrationId	string	De registratie-ID is een naam-in-hoofdletter string (tot 128 tekens lang) van alfanumerieke tekens plus bepaalde speciale tekens: . _ -. Geen speciale tekens toegestaan aan het begin of einde.
tpm	TpmAttestation	Attestatie via TPM.

Antwoorden

Name	Type	Description
200 OK	RegistrationOperationStatus	De aanvraag is voltooid.
202 Accepted	RegistrationOperationStatus	De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid. Kopteksten Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

RegistrationOperationStatus

De aanvraag is voltooid.

202 Accepted

RegistrationOperationStatus

De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid.

Kopteksten

Location: string
retry-after: integer

Other Status Codes

ProvisioningServiceErrorDetails

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Voorbeelden

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

RuntimeRegistration_RegisterDevice_MinimumSet_Gen

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

Voorbeeldaanvraag

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"
  }
}

Voorbeeldrespons

Statuscode:: 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"
}

Statuscode:: 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

Voorbeeldaanvraag

HTTP

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

{}

Voorbeeldrespons

Statuscode:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Statuscode:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Definities

Name	Description
AssignedDeviceSubstatus	Substatus voor 'Toegewezen' apparaten. Mogelijke waarden zijn onder andere: 'initialAssignment': Het apparaat is voor het eerst toegewezen aan een IoT-hub, 'deviceDataMigrated': Het apparaat is toegewezen aan een andere IoT-hub en de apparaatgegevens zijn geïmporteerd van de eerder toegewezen IoT-hub. Apparaatgegevens werden verwijderd van de eerder toegewezen IoT-hub, 'deviceDataReset': Het apparaat is toegewezen aan een andere IoT-hub en de apparaatgegevens zijn ingevuld vanuit de initiële status die in de inschrijving was opgeslagen. Apparaatgegevens zijn verwijderd van de eerder toegewezen IoT-hub, 'reprovisionedToInitialAssignment': Het apparaat is opnieuw geprovisioneerd naar een eerder toegewezen IoT-hub.
DeviceRegistration	Apparaatregistratie.
DeviceRegistrationResult	Resultaat van apparaatregistratie.
EnrollmentStatus	Inschrijvingsstatus.
ProvisioningServiceErrorDetails	Bevat de eigenschappen van een foutmelding die wordt teruggegeven door de Azure IoT Hub Provisioning Service.
RegistrationOperationStatus	Status van registratieoperatie.
SymmetricKeyRegistrationResult	Registratieresultaat werd teruggegeven bij gebruik van SymmetricKey-attestatie.
TpmAttestation	Attestatie via TPM.
TpmRegistrationResult	TPM-registratieresultaat.
X509CertificateInfo	X509-certificaatinformatie.
X509RegistrationResult	X509-registratieresultaat.

AssignedDeviceSubstatus

Opsomming

Substatus voor 'Toegewezen' apparaten. Mogelijke waarden zijn onder andere: 'initialAssignment': Het apparaat is voor het eerst toegewezen aan een IoT-hub, 'deviceDataMigrated': Het apparaat is toegewezen aan een andere IoT-hub en de apparaatgegevens zijn geïmporteerd van de eerder toegewezen IoT-hub. Apparaatgegevens werden verwijderd van de eerder toegewezen IoT-hub, 'deviceDataReset': Het apparaat is toegewezen aan een andere IoT-hub en de apparaatgegevens zijn ingevuld vanuit de initiële status die in de inschrijving was opgeslagen. Apparaatgegevens zijn verwijderd van de eerder toegewezen IoT-hub, 'reprovisionedToInitialAssignment': Het apparaat is opnieuw geprovisioneerd naar een eerder toegewezen IoT-hub.

Waarde	Description
initialAssignment	InitialToewijzing
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionedToInitialAssignment

DeviceRegistration

Object

Apparaatregistratie.

Name	Type	Description
payload		Elk object
registrationId	string	De registratie-ID is een naam-in-hoofdletter string (tot 128 tekens lang) van alfanumerieke tekens plus bepaalde speciale tekens: . _ -. Geen speciale tekens toegestaan aan het begin of einde.
tpm	TpmAttestation	Attestatie via TPM.

DeviceRegistrationResult

Object

Resultaat van apparaatregistratie.

Name	Type	Description
assignedHub	string	Assigned Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Registratie maakt datum aan (in UTC).
deviceId	string	Apparaat-id.
errorCode	integer (int32)	Foutcode.
errorMessage	string	Foutmelding.
etag	string	De entiteitstag die aan de bron is gekoppeld.
lastUpdatedDateTimeUtc	string (date-time)	Laatst bijgewerkte datum, tijd (in UTC).
payload		Elk object
registrationId	string	Dit ID wordt gebruikt om een apparaatregistratie van een registratie van een inschrijving uniek te identificeren. Een hoofdletter-ongevoelige string (tot 128 tekens lang) van alfanumerieke tekens plus bepaalde speciale tekens : . _ -. Geen speciale tekens toegestaan aan het begin of einde.
status	EnrollmentStatus	Inschrijvingsstatus.
substatus	AssignedDeviceSubstatus	Substatus voor 'Toegewezen' apparaten. Mogelijke waarden zijn onder andere: 'initialAssignment': Het apparaat is voor het eerst toegewezen aan een IoT-hub, 'deviceDataMigrated': Het apparaat is toegewezen aan een andere IoT-hub en de apparaatgegevens zijn geïmporteerd van de eerder toegewezen IoT-hub. Apparaatgegevens werden verwijderd van de eerder toegewezen IoT-hub, 'deviceDataReset': Het apparaat is toegewezen aan een andere IoT-hub en de apparaatgegevens zijn ingevuld vanuit de initiële status die in de inschrijving was opgeslagen. Apparaatgegevens zijn verwijderd van de eerder toegewezen IoT-hub, 'reprovisionedToInitialAssignment': Het apparaat is opnieuw geprovisioneerd naar een eerder toegewezen IoT-hub.
symmetricKey	SymmetricKeyRegistrationResult	Registratieresultaat werd teruggegeven bij gebruik van SymmetricKey-attestatie.
tpm	TpmRegistrationResult	TPM-registratieresultaat.
x509	X509RegistrationResult	X509-registratieresultaat.

EnrollmentStatus

Opsomming

Inschrijvingsstatus.

Waarde	Description
unassigned	Toegewezen
assigning	Toewijzing
assigned	toegewezen
failed	mislukt
disabled	uitgeschakeld

ProvisioningServiceErrorDetails

Object

Bevat de eigenschappen van een foutmelding die wordt teruggegeven door de Azure IoT Hub Provisioning Service.

Name	Type	Description
errorCode	integer (int32)	Numerieke foutcode.
info	object	Woordenlijst van <tekenreeks>
message	string	Foutmelding.
timestampUtc	string (date-time)	Fouttijdstempel (UTC).
trackingId	string	Fouttracking ID.

RegistrationOperationStatus

Object

Status van registratieoperatie.

Name	Type	Description
operationId	string minLength: 1	Operatie-ID.
registrationState	DeviceRegistrationResult	Resultaat van apparaatregistratie.
status	EnrollmentStatus	Status van apparaatregistratie.

SymmetricKeyRegistrationResult

Object

Registratieresultaat werd teruggegeven bij gebruik van SymmetricKey-attestatie.

Name	Type	Description
enrollmentGroupId	string	Id van inschrijvingsgroep.

TpmAttestation

Object

Attestatie via TPM.

Name	Type	Description
endorsementKey	string	TPM-endorsement sleutel.
storageRootKey	string	TPM-opslagroot key.

TpmRegistrationResult

Object

TPM-registratieresultaat.

Name	Type	Description
authenticationKey	string	Versleutelde authenticatiesleutel.

X509CertificateInfo

Object

X509-certificaatinformatie.

Name	Type	Description
issuerName	string	Naam van certificaatverlener.
notAfterUtc	string (date-time)	Vervaldatum van het certificaat (UTC).
notBeforeUtc	string (date-time)	Begindatum van certificaatgeldigheid (UTC).
serialNumber	string	Certificaat serienummer.
sha1Thumbprint	string	SHA-1 duimafdruk van het certificaat.
sha256Thumbprint	string	SHA-256 duimafdruk van het certificaat.
subjectName	string	Certificaatonderwerp.
version	integer (int32)	Certificaatversie.

X509RegistrationResult

Object

X509-registratieresultaat.

Name	Type	Description
certificateInfo	X509CertificateInfo	X509-certificaatinformatie.
enrollmentGroupId	string	Id van inschrijvingsgroep.
signingCertificateInfo	X509CertificateInfo	X509-certificaatinformatie.