Devices - Get Identity

IoT Hub の ID レジストリからデバイスを取得します。

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

URI パラメーター

Name / 必須 型 説明
id
path True

string

デバイスの一意識別子。

api-version
query True

string

API のバージョン。

応答

Name 型 説明
200 OK

Device

わかりました。

定義

Name 説明
AuthenticationMechanism
Device
DeviceCapabilities

デバイスで有効になっている機能の状態。

SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name 型 説明
symmetricKey

SymmetricKey

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

type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

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

x509Thumbprint

X509Thumbprint

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

Device

Name 型 説明
authentication

AuthenticationMechanism

デバイスで使用される認証メカニズム。

capabilities

DeviceCapabilities

デバイスの一連の機能。 たとえば、このデバイスがエッジ デバイスの場合などです。

cloudToDeviceMessageCount

integer (int32)

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

connectionState enum:
  • Connected
  • Disconnected

デバイスの状態。

connectionStateUpdatedTime

string (date-time)

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

deviceId

string

デバイスの一意識別子。

deviceScope

string

デバイスのスコープ。 エッジ デバイスに対して自動生成および変更不可。リーフ デバイスで変更可能で、子/親リレーションシップを作成します。

etag

string

RFC7232に従って、デバイス ID の弱い ETag を表す文字列。

generationId

string

IoT Hub によって生成される、大文字と小文字を区別する最大 128 文字の文字列。 この値は、削除されて再作成されたときに、同じ deviceId を持つデバイスを区別するために使用されます。

lastActivityTime

string (date-time)

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

parentScopes

string[]

該当する場合は、上位レベルのエッジ デバイスのスコープ。 エッジ デバイスでのみ使用できます。

status enum:
  • disabled
  • enabled

デバイスの状態。 状態が無効になっている場合、デバイスはサービスに接続できません。

statusReason

string

デバイス ID の状態の理由を格納する 128 文字の文字列。 すべての UTF-8 文字を使用できます。

statusUpdatedTime

string (date-time)

状態フィールドが最後に更新された日時。

DeviceCapabilities

デバイスで有効になっている機能の状態。

Name 型 説明
iotEdge

boolean

デバイスがエッジ デバイスかどうかを決定するプロパティ。

SymmetricKey

Name 型 説明
primaryKey

string

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

secondaryKey

string

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

X509Thumbprint

Name 型 説明
primaryThumbprint

string

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

secondaryThumbprint

string

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