Modules - Get Identity

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

Mendapatkan identitas modul pada perangkat.

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

Parameter URI

Name In Required Type Description
id
 path True
  • string

Pengidentifikasi unik perangkat.
mid
 path True
  • string

Pengidentifikasi unik modul.
api-version
 query True
  • string

Versi Api.

Respons

Name Type Description
200 OK

OK.

Definisi

AuthenticationMechanism
Module

Identitas modul 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.

Module

Identitas modul pada perangkat.

Name Type Description
authentication

Mekanisme autentikasi yang digunakan oleh modul saat menyambungkan ke layanan dan hub tepi.
cloudToDeviceMessageCount
  • integer

Jumlah pesan cloud-to-module saat ini mengantre untuk dikirim ke modul.
connectionState enum:
  • Connected
  • Disconnected

Status koneksi perangkat.
connectionStateUpdatedTime
  • string

Tanggal dan waktu status koneksi terakhir diperbarui.
deviceId
  • string

Pengidentifikasi unik perangkat.
etag
  • string

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

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

Tanggal dan waktu perangkat terakhir tersambung, diterima, atau mengirim pesan.
managedBy
  • string

Mengidentifikasi siapa yang mengelola modul ini. Misalnya, nilai ini adalah "IotEdge" jika runtime edge memiliki modul ini.
moduleId
  • string

Pengidentifikasi unik modul.

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.