Runtime Registration - Register Device

Dienst:: IoT Hub Device Provisioning Service

API-Version:: 2021-10-01

Registriert die Geräte.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
idScope	path	True	string	Der Umfang der DPS-Instanz.
registrationId	path	True	string	Die Registrierungs-ID ist alphanumerisch, kleingeschrieben und kann Bindestriche enthalten.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
payload		Jedes Objekt
registrationId	string	Die Registrierungs-ID ist eine kleinschreibungsunsensitive Zeichenkette (bis zu 128 Zeichen lang) aus alphanumerischen Zeichen plus bestimmten Sonderzeichen: . _ -. Keine Spezialzeichen zu Beginn oder Ende erlaubt.
tpm	TpmAttestation	Attestierung mittels TPM.

Antworten

Name	Typ	Beschreibung
200 OK	RegistrationOperationStatus	Die Anforderung war erfolgreich.
202 Accepted	RegistrationOperationStatus	Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen. Header Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

RegistrationOperationStatus

Die Anforderung war erfolgreich.

202 Accepted

RegistrationOperationStatus

Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Header

Location: string
retry-after: integer

Other Status Codes

ProvisioningServiceErrorDetails

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Beispiele

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

RuntimeRegistration_RegisterDevice_MinimumSet_Gen

RuntimeRegistration_RegisterDevice_MaximumSet_Gen

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

HTTP

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

{}

Beispiel für eine Antwort

Statuscode:: 200

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Statuscode:: 202

{
  "operationId": "xosjboksmobnotwgqejpvxiwi"
}

Definitionen

Name	Beschreibung
AssignedDeviceSubstatus	Substatus für 'zugewiesene' Geräte. Mögliche Werte sind - "initialAssignment": Das Gerät wurde erstmals einem IoT-Hub zugewiesen, "deviceDataMigrated": Das Gerät wurde einem anderen IoT-Hub zugewiesen und seine Gerätedaten wurden vom zuvor zugewiesenen IoT-Hub migriert. Gerätedaten wurden vom zuvor zugewiesenen IoT-Hub entfernt, 'deviceDataReset': Das Gerät wurde einem anderen IoT-Hub zugewiesen und seine Gerätedaten wurden aus dem ursprünglichen Zustand, der bei der Registrierung gespeichert war, ausgefüllt. Gerätedaten wurden vom zuvor zugewiesenen IoT-Hub entfernt, 'reprovisionedToInitialAssignment': Das Gerät wurde an einen zuvor zugewiesenen IoT-Hub neu bereitgestellt.
DeviceRegistration	Geräteregistrierung.
DeviceRegistrationResult	Ergebnis der Geräteregistrierung.
EnrollmentStatus	Einschreibungsstatus.
ProvisioningServiceErrorDetails	Enthält die Eigenschaften eines Fehlers, der vom Azure IoT Hub Provisioning Service zurückgegeben wird.
RegistrationOperationStatus	Status des Registrierungsbetriebs.
SymmetricKeyRegistrationResult	Das Registrierungsergebnis wurde bei Verwendung der SymmetricKey-Attestation zurückgegeben.
TpmAttestation	Attestierung mittels TPM.
TpmRegistrationResult	TPM-Registrierungsergebnis.
X509CertificateInfo	Informationen zum X509-Zertifikat.
X509RegistrationResult	X509-Registrierungsergebnis.

AssignedDeviceSubstatus

Enumeration

Substatus für 'zugewiesene' Geräte. Mögliche Werte sind - "initialAssignment": Das Gerät wurde erstmals einem IoT-Hub zugewiesen, "deviceDataMigrated": Das Gerät wurde einem anderen IoT-Hub zugewiesen und seine Gerätedaten wurden vom zuvor zugewiesenen IoT-Hub migriert. Gerätedaten wurden vom zuvor zugewiesenen IoT-Hub entfernt, 'deviceDataReset': Das Gerät wurde einem anderen IoT-Hub zugewiesen und seine Gerätedaten wurden aus dem ursprünglichen Zustand, der bei der Registrierung gespeichert war, ausgefüllt. Gerätedaten wurden vom zuvor zugewiesenen IoT-Hub entfernt, 'reprovisionedToInitialAssignment': Das Gerät wurde an einen zuvor zugewiesenen IoT-Hub neu bereitgestellt.

Wert	Beschreibung
initialAssignment	ursprüngliche Zuweisung
deviceDataMigrated	deviceDataMigrated
deviceDataReset	deviceDataReset
reprovisionedToInitialAssignment	reprovisionedToInitialAssignment

DeviceRegistration

Objekt

Geräteregistrierung.

Name	Typ	Beschreibung
payload		Jedes Objekt
registrationId	string	Die Registrierungs-ID ist eine kleinschreibungsunsensitive Zeichenkette (bis zu 128 Zeichen lang) aus alphanumerischen Zeichen plus bestimmten Sonderzeichen: . _ -. Keine Spezialzeichen zu Beginn oder Ende erlaubt.
tpm	TpmAttestation	Attestierung mittels TPM.

DeviceRegistrationResult

Objekt

Ergebnis der Geräteregistrierung.

Name	Typ	Beschreibung
assignedHub	string	Assigned Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Registrierung erstellt Datum (in UTC).
deviceId	string	Geräte-ID.
errorCode	integer (int32)	Fehlercode.
errorMessage	string	Fehlermeldung.
etag	string	Das mit der Ressource verknüpfte Entitäten-Tag.
lastUpdatedDateTimeUtc	string (date-time)	Zuletzt aktualisiertes Datum (in UTC).
payload		Jedes Objekt
registrationId	string	Diese ID wird verwendet, um eine Geräteregistrierung einer Einschreibung eindeutig zu identifizieren. Eine kleinschreibungsunempfindliche Zeichenkette (bis zu 128 Zeichen lang) aus alphanumerischen Zeichen plus bestimmten Sonderzeichen : . _ -. Keine Spezialzeichen zu Beginn oder Ende erlaubt.
status	EnrollmentStatus	Einschreibungsstatus.
substatus	AssignedDeviceSubstatus	Substatus für 'zugewiesene' Geräte. Mögliche Werte sind - "initialAssignment": Das Gerät wurde erstmals einem IoT-Hub zugewiesen, "deviceDataMigrated": Das Gerät wurde einem anderen IoT-Hub zugewiesen und seine Gerätedaten wurden vom zuvor zugewiesenen IoT-Hub migriert. Gerätedaten wurden vom zuvor zugewiesenen IoT-Hub entfernt, 'deviceDataReset': Das Gerät wurde einem anderen IoT-Hub zugewiesen und seine Gerätedaten wurden aus dem ursprünglichen Zustand, der bei der Registrierung gespeichert war, ausgefüllt. Gerätedaten wurden vom zuvor zugewiesenen IoT-Hub entfernt, 'reprovisionedToInitialAssignment': Das Gerät wurde an einen zuvor zugewiesenen IoT-Hub neu bereitgestellt.
symmetricKey	SymmetricKeyRegistrationResult	Das Registrierungsergebnis wurde bei Verwendung der SymmetricKey-Attestation zurückgegeben.
tpm	TpmRegistrationResult	TPM-Registrierungsergebnis.
x509	X509RegistrationResult	X509-Registrierungsergebnis.

EnrollmentStatus

Enumeration

Einschreibungsstatus.

Wert	Beschreibung
unassigned	Nicht zugewiesen
assigning	Zuweisung
assigned	zugewiesen
failed	misslungen
disabled	deaktiviert

ProvisioningServiceErrorDetails

Objekt

Enthält die Eigenschaften eines Fehlers, der vom Azure IoT Hub Provisioning Service zurückgegeben wird.

Name	Typ	Beschreibung
errorCode	integer (int32)	Numerischer Fehlercode.
info	object	Wörterbuch <Zeichenfolgen>
message	string	Fehlermeldung.
timestampUtc	string (date-time)	Fehlerzeitstempel (UTC).
trackingId	string	Fehlerverfolgungs-ID.

RegistrationOperationStatus

Objekt

Status des Registrierungsbetriebs.

Name	Typ	Beschreibung
operationId	string minLength: 1	Vorgangs-ID.
registrationState	DeviceRegistrationResult	Ergebnis der Geräteregistrierung.
status	EnrollmentStatus	Status der Einschreibung des Geräts.

SymmetricKeyRegistrationResult

Objekt

Das Registrierungsergebnis wurde bei Verwendung der SymmetricKey-Attestation zurückgegeben.

Name	Typ	Beschreibung
enrollmentGroupId	string	Registrierungsgruppen-ID.

TpmAttestation

Objekt

Attestierung mittels TPM.

Name	Typ	Beschreibung
endorsementKey	string	TPM-Endorsement-Schlüssel.
storageRootKey	string	TPM-Speicher-Root-Key.

TpmRegistrationResult

Objekt

TPM-Registrierungsergebnis.

Name	Typ	Beschreibung
authenticationKey	string	Verschlüsselter Authentifizierungsschlüssel.

X509CertificateInfo

Objekt

Informationen zum X509-Zertifikat.

Name	Typ	Beschreibung
issuerName	string	Name des Zertifikatausstellers.
notAfterUtc	string (date-time)	Ablaufdatum des Zertifikats (UTC).
notBeforeUtc	string (date-time)	Startdatum der Gültigkeit des Zertifikats (UTC).
serialNumber	string	Seriennummer des Zertifikats.
sha1Thumbprint	string	SHA-1-Daumenabdruck des Zertifikats.
sha256Thumbprint	string	SHA-256 Daumenabdruck des Zertifikats.
subjectName	string	Name des Zertifikatsfachs.
version	integer (int32)	Zertifikatversion.

X509RegistrationResult

Objekt

X509-Registrierungsergebnis.

Name	Typ	Beschreibung
certificateInfo	X509CertificateInfo	Informationen zum X509-Zertifikat.
enrollmentGroupId	string	Registrierungsgruppen-ID.
signingCertificateInfo	X509CertificateInfo	Informationen zum X509-Zertifikat.