Modules - Get Identity

デバイス上のモジュール ID を取得します。

GET https://fully-qualified-iothubname.azure-devices.net/devices/{id}/modules/{mid}?api-version=2021-04-12

URI パラメーター

名前 / 必須 説明
id
path True

string

デバイスの一意識別子。

mid
path True

string

モジュールの一意の識別子。

api-version
query True

string

Api のバージョン。

応答

名前 説明
200 OK

Module

OK です。

定義

名前 説明
AuthenticationMechanism
Module

デバイス上のモジュール ID。

SymmetricKey
X509Thumbprint

AuthenticationMechanism

名前 説明
symmetricKey

SymmetricKey

SAS ベースの認証に使用されるプライマリ キーとセカンダリ キー。

type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

サービスへの接続に使用される認証の種類。

x509Thumbprint

X509Thumbprint

x509 ベースの認証に使用されるプライマリとセカンダリの x509 拇印。

Module

デバイス上のモジュール ID。

名前 説明
authentication

AuthenticationMechanism

サービスとエッジ ハブに接続するときにモジュールによって使用される認証メカニズム。

cloudToDeviceMessageCount

integer

モジュールに送信するために現在キューに登録されている、クラウドからモジュールへのメッセージの数。

connectionState enum:
  • Connected
  • Disconnected

デバイスの接続状態。

connectionStateUpdatedTime

string

接続状態が最後に更新された日時。

deviceId

string

デバイスの一意識別子。

etag

string

RFC7232に従って、モジュール ID の弱い ETag を表す文字列。

generationId

string

IoT Hub、最大 128 文字の長さに大文字と小文字を区別する文字列が生成されます。 この値は、削除されて再作成されたときに、同じ moduleId を持つモジュールを区別するために使用されます。

lastActivityTime

string

デバイスが最後に接続、受信、またはメッセージを送信した日時。

managedBy

string

このモジュールを管理している主体を識別します。 たとえば、エッジ ランタイムによってこのモジュールが所有されている場合、この値は「IotEdge」になります。

moduleId

string

モジュールの一意の識別子。

SymmetricKey

名前 説明
primaryKey

string

デバイスの base64 でエンコードされた主キー。

secondaryKey

string

デバイスの base64 でエンコードされたセカンダリ キー。

X509Thumbprint

名前 説明
primaryThumbprint

string

X509 クライアント証明書のプライマリ拇印。

secondaryThumbprint

string

X509 クライアント証明書のセカンダリ拇印。