Runtime Registration - Register Device

  • Referenz
Service:
IoT Hub Device Provisioning Service
API Version:
2021-06-01

Registriert die Geräte.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
idScope
 path True

string

registrationId
 path True

string

Die Registrierungs-ID ist alphanumerisch und besteht aus Kleinbuchstaben und ggf. Bindestrichen.
api-version
 query True

string

API-Version, die für die Anforderung verwendet werden soll. Unterstützte Versionen sind: 2021-06-01

Anforderungstext

Name Typ Beschreibung
payload

object

Benutzerdefinierte Zuordnungsnutzlast.
registrationId

string

Bei der Registrierungs-ID handelt es sich um eine Zeichenfolge mit alphanumerischen Zeichen und bestimmten Sonderzeichen (bis zu 128 Zeichen lang) ohne Beachtung der Groß-/Kleinschreibung: . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.
tpm

TpmAttestation

Tpm.

Antworten

Name Typ Beschreibung
200 OK

RegistrationOperationStatus

Erfolg
202 Accepted

RegistrationOperationStatus

Erfolgreich

Headers

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

ProvisioningServiceErrorDetails

Fehlerantwort

Definitionen

Name Beschreibung
DeviceRegistration

Geräteregistrierung.
DeviceRegistrationResult

Ergebnis der Geräteregistrierung.
ProvisioningServiceErrorDetails

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

Registrierungsvorgang status.
SymmetricKeyRegistrationResult

Das Registrierungsergebnis wird zurückgegeben, wenn der SymmetricKey-Nachweis verwendet wird.
TpmAttestation

Nachweis über TPM.
TpmRegistrationResult

TPM-Registrierungsergebnis.
X509CertificateInfo

X509-Zertifikatinformationen.
X509RegistrationResult

X509-Registrierungsergebnis.

DeviceRegistration

Geräteregistrierung.

Name Typ Beschreibung
payload

object

Benutzerdefinierte Zuordnungsnutzlast.
registrationId

string

Bei der Registrierungs-ID handelt es sich um eine Zeichenfolge mit alphanumerischen Zeichen und bestimmten Sonderzeichen (bis zu 128 Zeichen lang) ohne Beachtung der Groß-/Kleinschreibung: . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.
tpm

TpmAttestation

Tpm.

DeviceRegistrationResult

Ergebnis der Geräteregistrierung.

Name Typ Beschreibung
assignedHub

string

Zugewiesene Azure IoT Hub.
createdDateTimeUtc

string

Anmeldedatum erstellen (in UTC).
deviceId

string

Geräte-ID.
errorCode

integer

Fehlercode
errorMessage

string

Fehlermeldung.
etag

string

Das Entitätstag, das der Ressource zugeordnet ist.
lastUpdatedDateTimeUtc

string

Datum der letzten Aktualisierung (in UTC).
payload

object

Benutzerdefinierte Zuordnungsnutzlast, die vom Webhook an das Gerät zurückgegeben wird.
registrationId

string

Die Registrierungs-ID ist alphanumerisch und besteht aus Kleinbuchstaben und ggf. Bindestrichen.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Registrierung status.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Unterstatus für "zugewiesene" Geräte. Mögliche Werte sind " initialAssignment": Das Gerät wurde zum ersten Mal einem IoT-Hub zugewiesen, "deviceDataMigrated": Das Gerät wurde einem anderen IoT Hub zugewiesen, und seine Gerätedaten wurden aus dem zuvor zugewiesenen IoT Hub migriert. Gerätedaten wurden aus dem zuvor zugewiesenen IoT Hub "deviceDataReset" entfernt: Das Gerät wurde einem anderen IoT Hub zugewiesen, und die Gerätedaten wurden aus dem ursprünglichen Zustand aufgefüllt, der in der Registrierung gespeichert wurde. Gerätedaten wurden aus dem zuvor zugewiesenen IoT Hub "reprovisionedToInitialAssignment" entfernt: Das Gerät wurde für einen zuvor zugewiesenen IoT Hub erneut bereitgestellt.
symmetricKey

SymmetricKeyRegistrationResult

Das Registrierungsergebnis wird zurückgegeben, wenn der SymmetricKey-Nachweis verwendet wird.
tpm

TpmRegistrationResult

Registrierungsergebnis, das bei Verwendung des TPM-Nachweises zurückgegeben wird.
x509

X509RegistrationResult

Das Registrierungsergebnis wird zurückgegeben, wenn der X509-Nachweis verwendet wird.

ProvisioningServiceErrorDetails

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

Name Typ Beschreibung
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

RegistrationOperationStatus

Registrierungsvorgang status.

Name Typ Beschreibung
operationId

string

Vorgangs-ID
registrationState

DeviceRegistrationResult

Geräteregistrierung status.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Geräteregistrierung status.

SymmetricKeyRegistrationResult

Das Registrierungsergebnis wird zurückgegeben, wenn der SymmetricKey-Nachweis verwendet wird.

Name Typ Beschreibung
enrollmentGroupId

string

TpmAttestation

Nachweis über TPM.

Name Typ Beschreibung
endorsementKey

string

storageRootKey

string

TpmRegistrationResult

TPM-Registrierungsergebnis.

Name Typ Beschreibung
authenticationKey

string

Verschlüsselter Authentifizierungsschlüssel.

X509CertificateInfo

X509-Zertifikatinformationen.

Name Typ Beschreibung
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509RegistrationResult

X509-Registrierungsergebnis.

Name Typ Beschreibung
certificateInfo

X509CertificateInfo

X509-Zertifikatinformationen.
enrollmentGroupId

string

signingCertificateInfo

X509CertificateInfo

X509-Zertifikatinformationen.