Device - Get Devices And Modules In Scope

サービス:

IoT Hub

API バージョン:

2021-04-12

IotHub にクエリを実行して、同じ deviceScope に属するデバイスに関する情報を取得します。 詳細については、https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language を参照してください。 結果の改ページ位置の修正がサポートされています。 これにより、デバイス ツインに関する情報のみが返されます。

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

URI パラメーター

名前	/	必須	型	説明
deviceId	path	True	string
moduleId	path	True	string
api-version	query	True	string	API のバージョン。

応答

名前	型	説明
200 OK	ScopeResult	必要に応じて、継続トークンを使用してスコープ内のデバイスを取得します。

定義

名前	説明
AuthenticationMechanism
Device
DeviceCapabilities	デバイスで有効になっている機能の状態。
Module	デバイス上のモジュール ID。
ScopeResult	クエリ結果。
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Object

名前	型	説明
symmetricKey	SymmetricKey	SAS ベースの認証に使用されるプライマリ キーとセカンダリ キー。
type	enum: certificateAuthority none sas selfSigned	サービスへの接続に使用される認証の種類。
x509Thumbprint	X509Thumbprint	x509 ベースの認証に使用されるプライマリとセカンダリの x509 拇印。

Device

Object

名前	型	説明
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

Object

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

名前	型	説明
iotEdge	boolean	デバイスがエッジ デバイスかどうかを決定するプロパティ。

Module

Object

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

名前	型	説明
authentication	AuthenticationMechanism	サービスとエッジ ハブに接続するときにモジュールによって使用される認証メカニズム。
cloudToDeviceMessageCount	integer (int32)	モジュールに送信するために現在キューに登録されている、クラウドからモジュールへのメッセージの数。
connectionState	enum: Connected Disconnected	デバイスの接続状態。
connectionStateUpdatedTime	string (date-time)	接続状態が最後に更新された日時。
deviceId	string	デバイスの一意識別子。
etag	string	RFC7232に従って、モジュール ID の弱い ETag を表す文字列。
generationId	string	IoT Hub によって生成された、最大 128 文字の大文字と小文字を区別する文字列。 この値は、削除されて再作成されたときに、同じ moduleId を持つモジュールを区別するために使用されます。
lastActivityTime	string (date-time)	デバイスが最後に接続、受信、またはメッセージを送信した日時。
managedBy	string	このモジュールを管理している主体を識別します。 たとえば、エッジ ランタイムがこのモジュールを所有している場合、この値は "IotEdge" になります。
moduleId	string	モジュールの一意識別子。

ScopeResult

Object

クエリ結果。

名前	型	説明
continuationLink	string	継続トークンを要求します。
devices	Device[]	コレクションとしてのスコープの結果項目。
modules	Module[]	コレクションとしてのスコープの結果項目。

SymmetricKey

Object

名前	型	説明
primaryKey	string	デバイスの base64 でエンコードされた主キー。
secondaryKey	string	デバイスの base64 でエンコードされたセカンダリ キー。

X509Thumbprint

Object

名前	型	説明
primaryThumbprint	string	X509 クライアント証明書のプライマリ拇印。
secondaryThumbprint	string	X509 クライアント証明書のセカンダリ拇印。