Runtime Registration - Register Device

Usługa:

IoT Hub Device Provisioning Service

Wersja interfejsu API:

2021-10-01

Rejestruje urządzenia.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
idScope	path	True	string
registrationId	path	True	string	Identyfikator rejestracji to alfanumeryczne, małe litery i może zawierać łączniki.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania. Obsługiwane wersje to: 2021-10-01

Treść żądania

Nazwa	Typ	Opis
payload	object
registrationId	string	Identyfikator rejestracji jest ciągiem bez uwzględniania wielkości liter (do 128 znaków) znaków alfanumerycznych oraz pewnymi znakami specjalnymi: . _ -. Bez znaków specjalnych dozwolonych na początku lub na końcu.
tpm	TpmAttestation	Zaświadczenie za pośrednictwem modułu TPM.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RegistrationOperationStatus	Powodzenie
202 Accepted	RegistrationOperationStatus	Zaakceptowano Nagłówki Location: string retry-after: integer
Other Status Codes	ProvisioningServiceErrorDetails	Odpowiedź na błąd Nagłówki x-ms-error-code: string

Definicje

Nazwa	Opis
DeviceRegistration	Rejestracja urządzenia.
DeviceRegistrationResult	Wynik rejestracji urządzenia.
ProvisioningServiceErrorDetails	Zawiera właściwości błędu zwróconego przez usługę Azure IoT Hub Provisioning Service.
RegistrationOperationStatus	Stan operacji rejestracji.
SymmetricKeyRegistrationResult	Wynik rejestracji zwrócony podczas korzystania z zaświadczania SymmetricKey.
TpmAttestation	Zaświadczenie za pośrednictwem modułu TPM.
TpmRegistrationResult	Wynik rejestracji modułu TPM.
X509CertificateInfo	Informacje o certyfikacie X509.
X509RegistrationResult	Wynik rejestracji X509.

DeviceRegistration

Objekt

Rejestracja urządzenia.

Nazwa	Typ	Opis
payload	object
registrationId	string	Identyfikator rejestracji jest ciągiem bez uwzględniania wielkości liter (do 128 znaków) znaków alfanumerycznych oraz pewnymi znakami specjalnymi: . _ -. Bez znaków specjalnych dozwolonych na początku lub na końcu.
tpm	TpmAttestation	Zaświadczenie za pośrednictwem modułu TPM.

DeviceRegistrationResult

Objekt

Wynik rejestracji urządzenia.

Nazwa	Typ	Opis
assignedHub	string	Przypisano usługę Azure IoT Hub.
createdDateTimeUtc	string (date-time)	Rejestracja tworzy datę i godzinę (w formacie UTC).
deviceId	string	Identyfikator urządzenia.
errorCode	integer (int32)	Kod błędu.
errorMessage	string	Komunikat o błędzie.
etag	string	Tag jednostki skojarzony z zasobem.
lastUpdatedDateTimeUtc	string (date-time)	Data ostatniej aktualizacji (w formacie UTC).
payload	object
registrationId	string	Ten identyfikator służy do unikatowego identyfikowania rejestracji urządzenia w ramach rejestracji. Ciąg bez uwzględniania wielkości liter (do 128 znaków) znaków alfanumerycznych oraz niektóre znaki specjalne: . _ -. Bez znaków specjalnych dozwolonych na początku lub na końcu.
status	enum: assigned assigning disabled failed unassigned	Stan rejestracji.
substatus	enum: deviceDataMigrated deviceDataReset initialAssignment reprovisionedToInitialAssignment	Podstatuj dla urządzeń przypisanych. Możliwe wartości to : "initialAssignment": Urządzenie zostało przypisane do centrum IoT po raz pierwszy "deviceDataMigrated": Urządzenie zostało przypisane do innego centrum IoT, a jego dane urządzenia zostały zmigrowane z wcześniej przypisanego centrum IoT. Dane urządzenia zostały usunięte z wcześniej przypisanego centrum IoT "deviceDataReset": urządzenie zostało przypisane do innego centrum IoT, a jego dane urządzenia zostały wypełnione ze stanu początkowego przechowywanego w rejestracji. Dane urządzenia zostały usunięte z wcześniej przypisanego centrum IoT Hub "reprovisionedToInitialAssignment": Urządzenie zostało ponownie aprowidowane do wcześniej przypisanego centrum IoT.
symmetricKey	SymmetricKeyRegistrationResult	Wynik rejestracji zwrócony podczas korzystania z zaświadczania SymmetricKey.
tpm	TpmRegistrationResult	Wynik rejestracji modułu TPM.
x509	X509RegistrationResult	Wynik rejestracji X509.

ProvisioningServiceErrorDetails

Objekt

Zawiera właściwości błędu zwróconego przez usługę Azure IoT Hub Provisioning Service.

Nazwa	Typ	Opis
errorCode	integer (int32)
info	object
message	string
timestampUtc	string (date-time)
trackingId	string

RegistrationOperationStatus

Objekt

Stan operacji rejestracji.

Nazwa	Typ	Opis
operationId	string minLength: 1	Identyfikator operacji.
registrationState	DeviceRegistrationResult	Wynik rejestracji urządzenia.
status	enum: assigned assigning disabled failed unassigned	Stan rejestracji urządzenia.

SymmetricKeyRegistrationResult

Objekt

Wynik rejestracji zwrócony podczas korzystania z zaświadczania SymmetricKey.

Nazwa	Typ	Opis
enrollmentGroupId	string

TpmAttestation

Objekt

Zaświadczenie za pośrednictwem modułu TPM.

Nazwa	Typ	Opis
endorsementKey	string
storageRootKey	string

TpmRegistrationResult

Objekt

Wynik rejestracji modułu TPM.

Nazwa	Typ	Opis
authenticationKey	string	Zaszyfrowany klucz uwierzytelniania.

X509CertificateInfo

Objekt

Informacje o certyfikacie X509.

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

X509RegistrationResult

Objekt

Wynik rejestracji X509.

Nazwa	Typ	Opis
certificateInfo	X509CertificateInfo	Informacje o certyfikacie X509.
enrollmentGroupId	string
signingCertificateInfo	X509CertificateInfo	Informacje o certyfikacie X509.