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
registrationId	path	True	string	Die Registrierungs-ID ist alphanumerisch, kleingeschrieben und kann Bindestriche enthalten.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll. Unterstützte Versionen sind: 2021-10-01

Anforderungstext

Name	Typ	Beschreibung
payload	object
registrationId	string	Die Registrierungs-ID ist eine Zeichenfolge ohne Groß-/Kleinschreibung (bis zu 128 Zeichen lang) von alphanumerischen Zeichen sowie bestimmte Sonderzeichen : . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.
tpm	TpmAttestation	Nachweis über TPM.

Antworten

Name	Typ	Beschreibung
200 OK	RegistrationOperationStatus	Erfolg
202 Accepted	RegistrationOperationStatus	Angenommen Header Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	Fehlerantwort Header x-ms-error-code: string

Definitionen

Name	Beschreibung
DeviceRegistration	Geräteregistrierung
DeviceRegistrationResult	Ergebnis der Geräteregistrierung.
ProvisioningServiceErrorDetails	Enthält die Eigenschaften eines Fehlers, der vom Azure IoT Hub-Bereitstellungsdienst zurückgegeben wird.
RegistrationOperationStatus	Registrierungsvorgangsstatus.
SymmetricKeyRegistrationResult	Das Registrierungsergebnis wird bei Verwendung des SymmetricKey-Nachweises zurückgegeben.
TpmAttestation	Nachweis über TPM.
TpmRegistrationResult	TPM-Registrierungsergebnis.
X509CertificateInfo	X509-Zertifikatinformationen.
X509RegistrationResult	X509-Registrierungsergebnis.

DeviceRegistration

Objekt

Geräteregistrierung

Name	Typ	Beschreibung
payload	object
registrationId	string	Die Registrierungs-ID ist eine Zeichenfolge ohne Groß-/Kleinschreibung (bis zu 128 Zeichen lang) von alphanumerischen Zeichen sowie bestimmte Sonderzeichen : . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.
tpm	TpmAttestation	Nachweis über TPM.

DeviceRegistrationResult

Objekt

Ergebnis der Geräteregistrierung.

Name	Typ	Beschreibung
assignedHub	string	Zugewiesener Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Die Registrierung erstellt Datumszeit (in UTC).
deviceId	string	Geräte-ID.
errorCode	integer (int32)	Fehlercode.
errorMessage	string	Fehlermeldung.
etag	string	Das Entitätstag, das der Ressource zugeordnet ist.
lastUpdatedDateTimeUtc	string (date-time)	Datum der letzten Aktualisierung (in UTC).
payload	object
registrationId	string	Diese ID wird verwendet, um eine Geräteregistrierung einer Registrierung eindeutig zu identifizieren. Eine Zeichenfolge ohne Groß-/Kleinschreibung (bis zu 128 Zeichen) alphanumerischer Zeichen sowie bestimmte Sonderzeichen : . _ -. Am Anfang oder Ende sind keine Sonderzeichen zulässig.
status	enum: assigned assigning disabled failed unassigned	Registrierungsstatus.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	Unterstatus für "Zugewiesene" Geräte. Mögliche Werte sind : "initialAssignment": Das Gerät wurde einem IoT-Hub zum ersten Mal "deviceDataMigrated" zugewiesen: Das Gerät wurde einem anderen IoT-Hub zugewiesen, und seine Gerätedaten wurden vom 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 ist. Gerätedaten wurden aus dem zuvor zugewiesenen IoT-Hub "reprovisionedToInitialAssignment" entfernt: Das Gerät wurde einem zuvor zugewiesenen IoT-Hub neu bereitgestellt.
symmetricKey	SymmetricKeyRegistrationResult	Das Registrierungsergebnis wird bei Verwendung des SymmetricKey-Nachweises zurückgegeben.
tpm	TpmRegistrationResult	TPM-Registrierungsergebnis.
x509	X509RegistrationResult	X509-Registrierungsergebnis.

ProvisioningServiceErrorDetails

Objekt

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

Name	Typ	Beschreibung
errorCode	integer (int32)
info	object
message	string
timestampUtc	string (date-time)
trackingId	string

RegistrationOperationStatus

Objekt

Registrierungsvorgangsstatus.

Name	Typ	Beschreibung
operationId	string minLength: 1	Vorgangs-ID.
registrationState	DeviceRegistrationResult	Ergebnis der Geräteregistrierung.
status	enum: assigned assigning disabled failed unassigned	Geräteregistrierungsstatus.

SymmetricKeyRegistrationResult

Objekt

Das Registrierungsergebnis wird bei Verwendung des SymmetricKey-Nachweises zurückgegeben.

Name	Typ	Beschreibung
enrollmentGroupId	string

TpmAttestation

Objekt

Nachweis über TPM.

Name	Typ	Beschreibung
endorsementKey	string
storageRootKey	string

TpmRegistrationResult

Objekt

TPM-Registrierungsergebnis.

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

X509CertificateInfo

Objekt

X509-Zertifikatinformationen.

Name	Typ	Beschreibung
issuerName	string
notAfterUtc	string (date-time)
notBeforeUtc	string (date-time)
serialNumber	string
sha1Thumbprint	string
sha256Thumbprint	string
subjectName	string
version	integer (int32)

X509RegistrationResult

Objekt

X509-Registrierungsergebnis.

Name	Typ	Beschreibung
certificateInfo	X509CertificateInfo	X509-Zertifikatinformationen.
enrollmentGroupId	string
signingCertificateInfo	X509CertificateInfo	X509-Zertifikatinformationen.