Device Registration State - Get

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

Mendapatkan status pendaftaran perangkat.

GET https://your-dps.azure-devices-provisioning.net/registrations/{id}?api-version=2021-06-01

Parameter URI

Name In Required Type Description
id
 path True
  • string

ID Pendaftaran.
api-version
 query True
  • string

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

Respons

Name Type Description
200 OK

Berhasil
Other Status Codes

Respons kesalahan

Definisi

DeviceRegistrationState

Status pendaftaran perangkat.
ProvisioningServiceErrorDetails

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

DeviceRegistrationState

Status 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.

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