Runtime Registration - Register Device

  • Başvuru
Hizmet:
IoT Hub Device Provisioning Service
API Sürümü:
2021-10-01

Cihazları kaydeder.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
idScope
 path True

string

registrationId
 path True

string

Kayıt kimliği alfasayısal, küçük harftir ve kısa çizgi içerebilir.
api-version
 query True

string

İstek için kullanılacak API sürümü. Desteklenen sürümler şunlardır: 2021-10-01

İstek Gövdesi

Name Tür Description
payload

object

registrationId

string

Kayıt kimliği, alfasayısal karakterlerin yanı sıra belirli özel karakterler içeren büyük/küçük harfe duyarlı olmayan bir dizedir (en fazla 128 karakter uzunluğunda). _ -. Başlangıç veya bitişte özel karaktere izin verilmez.
tpm

TpmAttestation

TPM aracılığıyla kanıtlama.

Yanıtlar

Name Tür Description
200 OK

RegistrationOperationStatus

Başarılı
202 Accepted

RegistrationOperationStatus

Kabul edildi

Üst Bilgiler

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

ProvisioningServiceErrorDetails

Hata yanıtı

Üst Bilgiler

x-ms-error-code: string

Tanımlar

Name Description
DeviceRegistration

Cihaz kaydı.
DeviceRegistrationResult

Cihaz kayıt sonucu.
ProvisioningServiceErrorDetails

Azure IoT Hub Sağlama Hizmeti tarafından döndürülen hatanın özelliklerini içerir.
RegistrationOperationStatus

Kayıt işlemi durumu.
SymmetricKeyRegistrationResult

Simetrik Anahtar kanıtlama kullanılırken kayıt sonucu döndürüldü.
TpmAttestation

TPM aracılığıyla kanıtlama.
TpmRegistrationResult

TPM kayıt sonucu.
X509CertificateInfo

X509 sertifika bilgileri.
X509RegistrationResult

X509 kayıt sonucu.

DeviceRegistration

Cihaz kaydı.

Name Tür Description
payload

object

registrationId

string

Kayıt kimliği, alfasayısal karakterlerin yanı sıra belirli özel karakterler içeren büyük/küçük harfe duyarlı olmayan bir dizedir (en fazla 128 karakter uzunluğunda). _ -. Başlangıç veya bitişte özel karaktere izin verilmez.
tpm

TpmAttestation

TPM aracılığıyla kanıtlama.

DeviceRegistrationResult

Cihaz kayıt sonucu.

Name Tür Description
assignedHub

string

Atanan Azure IoT Hub.
createdDateTimeUtc

string

Kayıt oluşturma tarihi saati (UTC olarak).
deviceId

string

Cihaz kimliği.
errorCode

integer

Hata kodu.
errorMessage

string

Hata iletisi.
etag

string

Kaynakla ilişkili varlık etiketi.
lastUpdatedDateTimeUtc

string

Son güncelleştirme tarihi saati (UTC olarak).
payload

object

registrationId

string

Bu kimlik, bir kaydın cihaz kaydını benzersiz olarak tanımlamak için kullanılır. Alfasayısal karakterlerden oluşan büyük/küçük harfe duyarlı olmayan dize (en fazla 128 karakter uzunluğunda) ve belirli özel karakterler : . _ -. Başlangıç veya bitişte özel karaktere izin verilmez.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Kayıt durumu.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

'Atanan' cihazlar için alt durum. Olası değerler şunlardır: 'initialAssignment': Cihaz ilk kez bir IoT hub'ına atandı, 'deviceDataMigrated': Cihaz farklı bir IoT hub'ına atandı ve cihaz verileri daha önce atanan IoT hub'ından geçirildi. Cihaz verileri daha önce atanmış olan 'deviceDataReset' IoT hub'ından kaldırıldı: Cihaz farklı bir IoT hub'ına atandı ve cihaz verileri kayıtta depolanan ilk durumdan dolduruldu. Cihaz verileri daha önce atanan 'reprovisionedToInitialAssignment' IoT hub'ından kaldırıldı: Cihaz daha önce atanmış bir IoT hub'ına yeniden sağlandı.
symmetricKey

SymmetricKeyRegistrationResult

Simetrik Anahtar kanıtlama kullanılırken kayıt sonucu döndürüldü.
tpm

TpmRegistrationResult

TPM kayıt sonucu.
x509

X509RegistrationResult

X509 kayıt sonucu.

ProvisioningServiceErrorDetails

Azure IoT Hub Sağlama Hizmeti tarafından döndürülen hatanın özelliklerini içerir.

Name Tür Description
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

RegistrationOperationStatus

Kayıt işlemi durumu.

Name Tür Description
operationId

string

İşlem Kimliği.
registrationState

DeviceRegistrationResult

Cihaz kayıt sonucu.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Cihaz kayıt durumu.

SymmetricKeyRegistrationResult

Simetrik Anahtar kanıtlama kullanılırken kayıt sonucu döndürüldü.

Name Tür Description
enrollmentGroupId

string

TpmAttestation

TPM aracılığıyla kanıtlama.

Name Tür Description
endorsementKey

string

storageRootKey

string

TpmRegistrationResult

TPM kayıt sonucu.

Name Tür Description
authenticationKey

string

Şifrelenmiş kimlik doğrulama anahtarı.

X509CertificateInfo

X509 sertifika bilgileri.

Name Tür Description
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509RegistrationResult

X509 kayıt sonucu.

Name Tür Description
certificateInfo

X509CertificateInfo

X509 sertifika bilgileri.
enrollmentGroupId

string

signingCertificateInfo

X509CertificateInfo

X509 sertifika bilgileri.