Runtime Registration - Device Registration Status Lookup

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

Mendapatkan status pendaftaran perangkat.

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

Parameter URI

Name In Required Type Description
idScope
 path True
  • string
registrationId
 path True
  • string

ID Pendaftaran.
api-version
 query True
  • string

Versi API yang digunakan untuk permintaan. Versi yang didukung meliputi: 2021-06-01

Isi Permintaan

Name Type Description
payload
  • object

Payload alokasi kustom.
registrationId
  • string

ID pendaftaran adalah string yang tidak peka huruf besar/kecil (panjangnya hingga 128 karakter) karakter alfanumerik ditambah karakter khusus tertentu: . _ -. Tidak ada karakter khusus yang diperbolehkan di awal atau akhir.
tpm

Tpm.

Respons

Name Type Description
200 OK

Berhasil
Other Status Codes

Respons kesalahan

Definisi

DeviceRegistration

Pendaftaran perangkat.
DeviceRegistrationResult

Hasil pendaftaran perangkat.
ProvisioningServiceErrorDetails

Berisi properti kesalahan yang dikembalikan oleh Layanan Provisi Azure IoT Hub.
SymmetricKeyRegistrationResult

Hasil pendaftaran dikembalikan saat menggunakan pengesahan SymmetricKey.
TpmAttestation

Pengesahan melalui TPM.
TpmRegistrationResult

Hasil pendaftaran TPM.
X509CertificateInfo

Info sertifikat X509.
X509RegistrationResult

Hasil pendaftaran X509.

DeviceRegistration

Pendaftaran perangkat.

Name Type Description
payload
  • object

Payload alokasi kustom.
registrationId
  • string

ID pendaftaran adalah string yang tidak peka huruf besar/kecil (panjangnya hingga 128 karakter) karakter alfanumerik ditambah karakter khusus tertentu: . _ -. Tidak ada karakter khusus yang diperbolehkan di awal atau akhir.
tpm

Tpm.

DeviceRegistrationResult

Hasil pendaftaran perangkat.

Name Type Description
assignedHub
  • string

Ditetapkan Azure IoT Hub.
createdDateTimeUtc
  • string

Waktu tanggal pembuatan pendaftaran (dalam UTC).
deviceId
  • string

ID perangkat.
errorCode
  • integer

Kode Kesalahan.
errorMessage
  • string

Pesan kesalahan.
etag
  • string

Tag entitas yang terkait dengan sumber daya.
lastUpdatedDateTimeUtc
  • string

Waktu tanggal terakhir diperbarui (dalam UTC).
payload
  • object

Payload alokasi kustom dikembalikan dari webhook ke perangkat.
registrationId
  • string

ID pendaftaran adalah alfanumerik, huruf kecil, dan mungkin berisi tanda hubung.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Status pendaftaran.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Substatus untuk perangkat 'Ditetapkan'. Nilai yang mungkin termasuk - 'initialAssignment': Perangkat telah ditetapkan ke hub IoT untuk pertama kalinya, 'deviceDataMigrated': Perangkat telah ditetapkan ke hub IoT yang berbeda dan data perangkatnya dimigrasikan dari hub IoT yang ditetapkan sebelumnya. Data perangkat dihapus dari hub IoT yang ditetapkan sebelumnya, 'deviceDataReset': Perangkat telah ditetapkan ke hub IoT yang berbeda dan data perangkatnya diisi dari status awal yang disimpan dalam pendaftaran. Data perangkat dihapus dari hub IoT yang ditetapkan sebelumnya, 'reprovisionedToInitialAssignment': Perangkat telah diprovisikan ulang ke hub IoT yang ditetapkan sebelumnya.
symmetricKey

Hasil pendaftaran dikembalikan saat menggunakan pengesahan SymmetricKey.
tpm

Hasil pendaftaran dikembalikan saat menggunakan pengesahan TPM.
x509

Hasil pendaftaran dikembalikan saat menggunakan pengesahan X509.

ProvisioningServiceErrorDetails

Berisi properti kesalahan yang dikembalikan oleh Layanan Provisi Azure IoT Hub.

Name Type Description
errorCode
  • integer
info
  • object
message
  • string
timestampUtc
  • string
trackingId
  • string

SymmetricKeyRegistrationResult

Hasil pendaftaran dikembalikan saat menggunakan pengesahan SymmetricKey.

Name Type Description
enrollmentGroupId
  • string

TpmAttestation

Pengesahan melalui TPM.

Name Type Description
endorsementKey
  • string
storageRootKey
  • string

TpmRegistrationResult

Hasil pendaftaran TPM.

Name Type Description
authenticationKey
  • string

Kunci autentikasi terenkripsi.

X509CertificateInfo

Info sertifikat X509.

Name Type Description
issuerName
  • string
notAfterUtc
  • string
notBeforeUtc
  • string
serialNumber
  • string
sha1Thumbprint
  • string
sha256Thumbprint
  • string
subjectName
  • string
version
  • integer

X509RegistrationResult

Hasil pendaftaran X509.

Name Type Description
certificateInfo

Info sertifikat X509.
enrollmentGroupId
  • string
signingCertificateInfo

Info sertifikat X509.