Modules - Get Identity

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

取得裝置上的模組身分識別。

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

URI 參數

Name In Required Type Description
id
 path True
  • string

裝置的唯一識別碼。
mid
 path True
  • string

模組的唯一識別碼。
api-version
 query True
  • string

Api 的版本。

回應

Name Type Description
200 OK

正常。

定義

AuthenticationMechanism
Module

裝置上的模組身分識別。
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name Type Description
symmetricKey

用於 SAS 型驗證的主要和次要金鑰。
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

用來連線至服務的驗證類型。
x509Thumbprint

用於 x509 型驗證的主要和次要 x509 指紋。

Module

裝置上的模組身分識別。

Name Type Description
authentication

連線到服務和邊緣中樞時，模組所使用的驗證機制。
cloudToDeviceMessageCount
  • integer

目前佇列要傳送至模組的雲端到模組訊息數目。
connectionState enum:
  • Connected
  • Disconnected

裝置的線上狀態。
connectionStateUpdatedTime
  • string

上次更新線上狀態的日期和時間。
deviceId
  • string

裝置的唯一識別碼。
etag
  • string

根據 RFC7232，代表模組身分識別的弱式 ETag 字串。
generationId
  • string

IoT 中樞產生的區分大小寫字串長度最多為 128 個字元。 當模組遭到刪除並重新建立時，這個值會用來區分具有相同 moduleId 的模組。
lastActivityTime
  • string

裝置上次連線、接收或傳送訊息的日期和時間。
managedBy
  • string

識別管理此課程模組的人員。 例如，如果邊緣執行時間擁有此模組，這個值會是 「IotEdge」。
moduleId
  • string

模組的唯一識別碼。

SymmetricKey

Name Type Description
primaryKey
  • string

裝置的 base64 編碼主鍵。
secondaryKey
  • string

裝置的 base64 編碼次要金鑰。

X509Thumbprint

Name Type Description
primaryThumbprint
  • string

X509 用戶端憑證主要指紋。
secondaryThumbprint
  • string

X509 用戶端憑證次要指紋。