Query - Get Twins
IoT Hub にクエリを実行し、SQL に似た言語を使用してデバイス ツインに関する情報を取得します。 詳細については、https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language を参照してください。 改ページ位置の設定がサポートされています。 これにより、デバイス ツインに関する情報のみが返されます。
POST https://fully-qualified-iothubname.azure-devices.net/devices/query?api-version=2021-04-12URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
API のバージョン。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-continuation |
string |
結果の次のページを取得するために使用される継続トークン。 |
|
| x-ms-max-item-count |
string |
1 ページあたりに返されるアイテムの最大数。 指定された値が受け入れられない場合、サービスで別の値が使用される場合があります。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| query |
string |
クエリ文字列。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
Twin[] |
わかりました。 ヘッダー
|
定義
| 名前 | 説明 |
|---|---|
|
Device |
デバイスで有効になっている機能の状態。 |
|
Query |
Json クエリ要求。 |
| Twin |
デバイスまたはモジュールの状態情報。 これは、対応するデバイス/モジュール ID が IoT Hub で作成または削除されるときに、暗黙的に作成および削除されます。 |
|
Twin |
ツインの必要なプロパティと報告されるプロパティ。 オブジェクトの最大深度は 10 です。 |
| X509Thumbprint |
DeviceCapabilities
デバイスで有効になっている機能の状態。
| 名前 | 型 | 説明 |
|---|---|---|
| iotEdge |
boolean |
デバイスがエッジ デバイスかどうかを決定するプロパティ。 |
QuerySpecification
Json クエリ要求。
| 名前 | 型 | 説明 |
|---|---|---|
| query |
string |
クエリ文字列。 |
Twin
デバイスまたはモジュールの状態情報。 これは、対応するデバイス/モジュール ID が IoT Hub で作成または削除されるときに、暗黙的に作成および削除されます。
| 名前 | 型 | 説明 |
|---|---|---|
| authenticationType |
enum:
|
デバイスで使用される認証の種類。 |
| capabilities |
デバイスで有効になっている機能の状態。 |
|
| cloudToDeviceMessageCount |
integer (int32) |
送信されたクラウドからデバイスへのメッセージの数。 |
| connectionState |
enum:
|
デバイスの接続状態。 |
| deviceEtag |
string |
RFC7232に従って、デバイスの ETag を表す文字列。 |
| deviceId |
string |
IoT Hub の ID レジストリ内のデバイスの一意識別子。 これは、ASCII 7 ビット英数字文字の大文字と小文字を区別する文字列 (最大 128 文字) です。 次の特殊文字 {'-'、':'、'.'、'+'、'%', '_', '#', '*', '?', '!', '(', ')',','','=', '@', ';', '$', '''} です。 |
| deviceScope |
string |
デバイスのスコープ。 |
| etag |
string |
RFC7232に従って、デバイス ツインの ETag を表す文字列。 |
| lastActivityTime |
string (date-time) |
デバイスが最後に接続または受信またはメッセージを送信した日時。 日付と時刻は、2015-01-28T16:24:48.789Z など、UTC ISO8601 datetime 形式で分離されます。 デバイスが HTTP/1 プロトコルを使用してメッセージング操作を実行する場合、この値は更新されません。 |
| moduleId |
string |
IoT Hub の ID レジストリ内のモジュールの一意識別子。 これは、ASCII 7 ビット英数字文字の大文字と小文字を区別する文字列 (最大 128 文字) です。 次の特殊文字 {'-'、':'、'.'、'+'、'%', '_', '#', '*', '?', '!', '(', ')',','','=', '@', ';', '$', '''} です。 |
| parentScopes |
string[] |
該当する場合は、上位レベルのエッジ デバイスのスコープ。 エッジ デバイスでのみ使用できます。 |
| properties |
ツインの必要なプロパティと報告されるプロパティ。 |
|
| status |
enum:
|
デバイスの有効な状態。 無効にした場合、デバイスはサービスに接続できません。 |
| statusReason |
string |
デバイスの現在の状態の理由 (ある場合)。 |
| statusUpdateTime |
string (date-time) |
デバイスの状態が最後に更新された日時。 |
| tags |
object |
ソリューション バックエンドによって読み書きされるキーと値のペアのコレクション。 デバイス アプリには表示されません。 これらのキーは UTF-8 でエンコードされ、大文字と小文字が区別され、長さが 1 KB up-to。 使用できる文字は、UNICODE 制御文字 (セグメント C0 および C1)、'.'、'$'、およびスペースを除外します。 値は JSON オブジェクトであり、長さは 4 KB up-to。 |
| version |
integer (int64) |
タグと必要なプロパティを含むデバイス ツインのバージョン |
| x509Thumbprint |
デバイスの X509 拇印。 |
TwinProperties
ツインの必要なプロパティと報告されるプロパティ。 オブジェクトの最大深度は 10 です。
| 名前 | 型 | 説明 |
|---|---|---|
| desired |
object |
目的のプロパティ キーと値のペアのコレクション。 キーは UTF-8 でエンコードされ、大文字と小文字が区別され、長さが 1 KB up-to。 使用できる文字は、UNICODE 制御文字 (セグメント C0 および C1)、'.'、'$'、およびスペースを除外します。 必要な値は JSON オブジェクトであり、長さは 4 KB up-to。 |
| reported |
object |
報告されるプロパティのキーと値のペアのコレクション。 キーは UTF-8 でエンコードされ、大文字と小文字が区別され、長さが 1 KB up-to。 使用できる文字は、UNICODE 制御文字 (セグメント C0 および C1)、'.'、'$'、およびスペースを除外します。 報告されるプロパティ値は JSON オブジェクトであり、長さは 4 KB up-to。 |
X509Thumbprint
| 名前 | 型 | 説明 |
|---|---|---|
| primaryThumbprint |
string |
X509 クライアント証明書のプライマリ拇印。 |
| secondaryThumbprint |
string |
X509 クライアント証明書のセカンダリ拇印。 |