Devices - Get Identity

  • Referensi
Service:
IoT Hub
API Version:
2020-05-31-preview

Mendapatkan perangkat dari registri identitas IoT Hub.

GET https://fully-qualified-iothubname.azure-devices.net/devices/{id}?api-version=2020-05-31-preview

Parameter URI

Name In Required Type Description
id
 path True
  • string

Pengidentifikasi unik perangkat.
api-version
 query True
  • string

Versi Api.

Respons

Name Type Description
200 OK

OK.

Definisi

AuthenticationMechanism
Device
DeviceCapabilities

Status kemampuan yang diaktifkan pada perangkat.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name Type Description
symmetricKey

Kunci primer dan sekunder yang digunakan untuk autentikasi berbasis SAS.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Jenis autentikasi yang digunakan untuk menyambungkan ke layanan.
x509Thumbprint

Thumbprint x509 primer dan sekunder yang digunakan untuk autentikasi berbasis x509.

Device

Name Type Description
authentication

Mekanisme autentikasi yang digunakan oleh perangkat.
capabilities

Set kemampuan perangkat. Misalnya, jika perangkat ini adalah perangkat edge atau tidak.
cloudToDeviceMessageCount
  • integer

Jumlah pesan cloud-ke-perangkat yang saat ini diantrekan untuk dikirim ke perangkat.
connectionState enum:
  • Connected
  • Disconnected

Status perangkat.
connectionStateUpdatedTime
  • string

Tanggal dan waktu status koneksi terakhir diperbarui.
deviceId
  • string

Pengidentifikasi unik perangkat.
deviceScope
  • string

Cakupan perangkat. Dibuat secara otomatis dan tidak dapat diubah untuk perangkat edge dan dapat dimodifikasi di perangkat daun untuk membuat hubungan anak/induk.
etag
  • string

String yang mewakili ETag yang lemah untuk identitas perangkat, sesuai RFC7232.
generationId
  • string

String peka huruf besar/kecil yang dihasilkan IoT Hub hingga 128 karakter. Nilai ini digunakan untuk membedakan perangkat dengan deviceId yang sama, ketika telah dihapus dan dibuat ulang.
lastActivityTime
  • string

Tanggal dan terakhir kali perangkat terakhir tersambung, menerima, atau mengirim pesan.
status enum:
  • disabled
  • enabled

Status perangkat. Jika status dinonaktifkan, perangkat tidak dapat tersambung ke layanan.
statusReason
  • string

String sepanjang 128 karakter yang menyimpan alasan status identitas perangkat. Semua karakter UTF-8 diperbolehkan.
statusUpdatedTime
  • string

Tanggal dan waktu saat bidang status terakhir diperbarui.

DeviceCapabilities

Status kemampuan yang diaktifkan pada perangkat.

Name Type Description
iotEdge
  • boolean

Properti yang menentukan apakah perangkat adalah perangkat edge atau tidak.

SymmetricKey

Name Type Description
primaryKey
  • string

Kunci primer perangkat yang dikodekan base64.
secondaryKey
  • string

Kunci sekunder perangkat yang dikodekan base64.

X509Thumbprint

Name Type Description
primaryThumbprint
  • string

Thumbprint utama sertifikat klien X509.
secondaryThumbprint
  • string

Thumbprint sekunder sertifikat klien X509.