Query - Get Twins

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

Kueri IoT Hub untuk mengambil informasi mengenai kembar perangkat menggunakan bahasa seperti SQL. Lihat https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language untuk informasi lebih lanjut. Penomoran halaman didukung. Ini mengembalikan informasi tentang perangkat kembar saja.

POST https://fully-qualified-iothubname.azure-devices.net/devices/query?api-version=2020-05-31-preview

Parameter URI

Name In Required Type Description
api-version
 query True
  • string

Versi Api.

Header Permintaan

Name Required Type Description
x-ms-continuation
  • string

Token kelanjutan yang digunakan untuk mendapatkan halaman hasil berikutnya.
x-ms-max-item-count
  • string

Jumlah maksimum item yang dikembalikan per halaman. Layanan dapat menggunakan nilai yang berbeda jika nilai yang ditentukan tidak dapat diterima.

Isi Permintaan

Name Type Description
query
  • string

String kueri.

Respons

Name Type Description
200 OK

OK.

Headers

  • x-ms-item-type: string
  • x-ms-continuation: string

Definisi

DeviceCapabilities

Status kemampuan yang diaktifkan pada perangkat.
QuerySpecification

Permintaan kueri Json.
Twin

Informasi status untuk perangkat atau modul. Ini secara implisit dibuat dan dihapus saat identitas perangkat/modul yang sesuai dibuat atau dihapus di IoT Hub.
TwinProperties

Properti kembar yang diinginkan dan dilaporkan. Kedalaman maksimum objek adalah 10.
X509Thumbprint

DeviceCapabilities

Status kemampuan yang diaktifkan pada perangkat.

Name Type Description
iotEdge
  • boolean

Properti yang menentukan apakah perangkat adalah perangkat edge atau tidak.

QuerySpecification

Permintaan kueri Json.

Name Type Description
query
  • string

String kueri.

Twin

Informasi status untuk perangkat atau modul. Ini secara implisit dibuat dan dihapus saat identitas perangkat/modul yang sesuai dibuat atau dihapus di IoT Hub.

Name Type Description
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Jenis autentikasi yang digunakan oleh perangkat.
capabilities

Status kemampuan yang diaktifkan pada perangkat.
cloudToDeviceMessageCount
  • integer

Jumlah pesan cloud-ke-perangkat yang dikirim.
connectionState enum:
  • Connected
  • Disconnected

Status koneksi perangkat.
deviceEtag
  • string

String yang mewakili ETag untuk perangkat, sesuai RFC7232.
deviceId
  • string

Pengidentifikasi unik perangkat dalam registri identitas IoT Hub. Ini adalah string peka huruf besar/kecil (panjang hingga 128 karakter) karakter alfanumerik ASCII 7-bit, dan karakter khusus berikut {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
deviceScope
  • string

Cakupan perangkat.
etag
  • string

String yang mewakili ETag untuk perangkat kembar, sesuai RFC7232.
lastActivityTime
  • string

Tanggal dan waktu saat perangkat terakhir tersambung atau menerima atau mengirim pesan. Tanggal dan waktu dipisahkan dalam format tanggalwaktu ISO8601 dalam UTC, misalnya, 2015-01-28T16:24:48.789Z. Nilai ini tidak diperbarui jika perangkat menggunakan protokol HTTP/1 untuk melakukan operasi olahpesan.
moduleId
  • string

Pengidentifikasi unik modul dalam registri identitas IoT Hub. Ini adalah string peka huruf besar/kecil (panjang hingga 128 karakter) karakter alfanumerik ASCII 7-bit, dan karakter khusus berikut {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
properties

Properti kembar yang diinginkan dan dilaporkan.
status enum:
  • disabled
  • enabled

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

Alasan status perangkat saat ini, jika ada.
statusUpdateTime
  • string

Tanggal dan waktu saat status perangkat terakhir diperbarui.
tags
  • object

Kumpulan pasangan kunci-nilai yang dibaca dan ditulis oleh back end solusi. Mereka tidak terlihat oleh aplikasi perangkat. Kuncinya adalah UTF-8 yang dikodekan, peka huruf besar/kecil, dan panjangnya hingga 1KB. Karakter yang diizinkan mengecualikan karakter kontrol UNICODE (segmen C0 dan C1), '.', '$' dan spasi. Nilainya adalah objek JSON, panjangnya hingga 4KB.
version
  • integer

Versi untuk perangkat kembar termasuk tag dan properti yang diinginkan
x509Thumbprint

Thumbprint X509 perangkat.

TwinProperties

Properti kembar yang diinginkan dan dilaporkan. Kedalaman maksimum objek adalah 10.

Name Type Description
desired
  • object

Kumpulan pasangan kunci-nilai properti yang diinginkan. Kuncinya adalah UTF-8 yang dikodekan, peka huruf besar/kecil, dan panjangnya hingga 1KB. Karakter yang diizinkan mengecualikan karakter kontrol UNICODE (segmen C0 dan C1), '.', '$' dan spasi. Nilai porperty yang diinginkan adalah objek JSON, panjangnya hingga 4KB.
reported
  • object

Kumpulan pasangan kunci-nilai properti yang dilaporkan. Kuncinya adalah UTF-8 yang dikodekan, peka huruf besar/kecil, dan panjangnya hingga 1KB. Karakter yang diizinkan mengecualikan karakter kontrol UNICODE (segmen C0 dan C1), '.', '$' dan spasi. Nilai properti yang dilaporkan adalah objek JSON, panjangnya hingga 4KB.

X509Thumbprint

Name Type Description
primaryThumbprint
  • string

Thumbprint utama sertifikat klien X509.
secondaryThumbprint
  • string

Thumbprint sekunder sertifikat klien X509.