Devices - Get Identity
Mendapatkan perangkat dari registri identitas IoT Hub.
GET https://fully-qualified-iothubname.azure-devices.net/devices/{id}?api-version=2021-04-12
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
id
|
path | True |
string |
Pengidentifikasi unik perangkat. |
api-version
|
query | True |
string |
Versi Api. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
OK. |
Definisi
Nama | Deskripsi |
---|---|
Authentication |
|
Device | |
Device |
Status kemampuan yang diaktifkan pada perangkat. |
Symmetric |
|
X509Thumbprint |
AuthenticationMechanism
Nama | Jenis | Deskripsi |
---|---|---|
symmetricKey |
Kunci primer dan sekunder yang digunakan untuk autentikasi berbasis SAS. |
|
type |
enum:
|
Jenis autentikasi yang digunakan untuk menyambungkan ke layanan. |
x509Thumbprint |
Thumbprint x509 primer dan sekunder yang digunakan untuk autentikasi berbasis x509. |
Device
Nama | Jenis | Deskripsi |
---|---|---|
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:
|
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:
|
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. |