Devices - Get Identity

Layanan:

IoT Hub

Versi API:

2021-04-12

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	Device	OKE.

Definisi

Nama	Deskripsi
AuthenticationMechanism
Device
DeviceCapabilities	Status kemampuan yang diaktifkan pada perangkat.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Objek

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

Objek

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 (int32)	Jumlah pesan cloud-ke-perangkat yang saat ini diantrekan untuk dikirim ke perangkat.
connectionState	enum: Connected Disconnected	Status perangkat.
connectionStateUpdatedTime	string (date-time)	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 turunan/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 (date-time)	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 panjang 128 karakter yang menyimpan alasan status identitas perangkat. Semua karakter UTF-8 diperbolehkan.
statusUpdatedTime	string (date-time)	Tanggal dan waktu ketika bidang status terakhir diperbarui.

DeviceCapabilities

Objek

Status kemampuan yang diaktifkan pada perangkat.

Nama	Jenis	Deskripsi
iotEdge	boolean	Properti yang menentukan apakah perangkat adalah perangkat edge atau tidak.

SymmetricKey

Objek

Nama	Jenis	Deskripsi
primaryKey	string	Kunci utama perangkat yang dikodekan base64.
secondaryKey	string	Kunci sekunder perangkat yang dikodekan base64.

X509Thumbprint

Objek

Nama	Jenis	Deskripsi
primaryThumbprint	string	Thumbprint utama sertifikat klien X509.
secondaryThumbprint	string	Thumbprint sekunder sertifikat klien X509.