Bagikan melalui

Devices - Get Devices

  • Referensi
Layanan:
IoT Hub
Versi API:
2021-04-12

Mendapatkan identitas beberapa perangkat dari registri identitas IoT Hub. Tidak direkomendasikan. Gunakan API kueri IoT Hub untuk mengambil informasi identitas perangkat kembar dan perangkat. Lihat https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub dan https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language untuk informasi selengkapnya.

GET https://fully-qualified-iothubname.azure-devices.net/devices?api-version=2021-04-12
Dengan parameter opsional: 
GET https://fully-qualified-iothubname.azure-devices.net/devices?top={top}&api-version=2021-04-12

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
api-version
 query True

string

Versi Api.
top
 query

integer

int32

Jumlah maksimum identitas perangkat yang dikembalikan oleh kueri. Nilai apa pun di luar rentang 1-1000 dianggap 1000.

Respons

Nama Jenis Deskripsi
200 OK

Device[]

OK.

Definisi

Nama Deskripsi
AuthenticationMechanism
Device
DeviceCapabilities

Status kemampuan yang diaktifkan pada perangkat.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Nama Jenis Deskripsi
symmetricKey

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

X509Thumbprint

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

Device

Nama Jenis Deskripsi
authentication

AuthenticationMechanism

Mekanisme autentikasi yang digunakan oleh perangkat.
capabilities

DeviceCapabilities

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

string[]

Cakupan perangkat tepi tingkat atas jika berlaku. Hanya tersedia untuk perangkat edge.
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.

Nama Jenis Deskripsi
iotEdge

boolean

Properti yang menentukan apakah perangkat adalah perangkat edge atau tidak.

SymmetricKey

Nama Jenis Deskripsi
primaryKey

string

Kunci primer perangkat yang dikodekan base64.
secondaryKey

string

Kunci sekunder yang dikodekan base64 dari perangkat.

X509Thumbprint

Nama Jenis Deskripsi
primaryThumbprint

string

Thumbprint utama sertifikat klien X509.
secondaryThumbprint

string

Thumbprint sekunder sertifikat klien X509.