az iot hub device-twin
Note
This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). 拡張機能は、az iot hub device-twin コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.
IoT デバイス ツインの構成を管理します。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az iot hub device-twin list |
IoT Hub 内のデバイス ツインを一覧表示します。 |
Extension | GA |
az iot hub device-twin replace |
デバイス ツイン定義をターゲット json に置き換えます。 |
Extension | GA |
az iot hub device-twin show |
デバイス ツイン定義を取得します。 |
Extension | GA |
az iot hub device-twin update |
デバイス ツインの必要なプロパティとタグを更新します。 |
Extension | GA |
az iot hub device-twin list
IoT Hub 内のデバイス ツインを一覧表示します。
このコマンドは、すべてのデバイスに対して "select * from devices" というクエリを使用し、エッジ デバイスの場合は "select * where devices where capabilities.iotEdge = true" の IoT Hub クエリと同じです。
az iot hub query
を使用して、デバイスに対するより強力なクエリを実行します。
az iot hub device-twin list [--auth-type {key, login}]
[--edge-enabled --ee {false, true}]
[--hub-name]
[--login]
[--resource-group]
[--top]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。既定値は、 az configure --defaults iothub-data-auth-type={auth-type-value}
を使用して構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Access Control Arguments |
規定値: | key |
指定可能な値: | key, login |
エッジの有効化を示すフラグ。
プロパティ | 値 |
---|---|
規定値: | False |
指定可能な値: | false, true |
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
返される要素の最大数。 無制限に -1 を使用します。
プロパティ | 値 |
---|---|
規定値: | 1000 |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az iot hub device-twin replace
デバイス ツイン定義をターゲット json に置き換えます。
JSON を直接入力するか、ファイル パスを使用します。
az iot hub device-twin replace --device-id
--json
[--auth-type {key, login}]
[--etag]
[--hub-name]
[--login]
[--resource-group]
例
デバイス ツインをファイルの内容に置き換えます。
az iot hub device-twin replace -d {device_id} -n {iothub_name} -j ../mydevicetwin.json
必須のパラメーター
ターゲット デバイス ID。
既存のツインを置き換える Json。 ファイル パスまたは生の json を指定します。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。既定値は、 az configure --defaults iothub-data-auth-type={auth-type-value}
を使用して構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Access Control Arguments |
規定値: | key |
指定可能な値: | key, login |
リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az iot hub device-twin show
デバイス ツイン定義を取得します。
az iot hub device-twin show --device-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
必須のパラメーター
ターゲット デバイス ID。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。既定値は、 az configure --defaults iothub-data-auth-type={auth-type-value}
を使用して構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Access Control Arguments |
規定値: | key |
指定可能な値: | key, login |
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az iot hub device-twin update
デバイス ツインの必要なプロパティとタグを更新します。
PATCH 動作の --desired 引数または --tags 引数を指定します。 どちらのパラメーターも、インライン json または json コンテンツへのファイル パスをサポートします。 一般的な更新引数 (--set) の使用は PUT の動作を反映し、非推奨とされます。
az iot hub device-twin update --device-id
[--add]
[--auth-type {key, login}]
[--desired]
[--etag]
[--force-string]
[--hub-name]
[--login]
[--remove]
[--resource-group]
[--set]
[--tags]
例
デバイス ツインの必要なプロパティにパッチを適用します。
az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'
デバイス ツイン タグにパッチを適用します。
az iot hub device-twin update -n {iothub_name} -d {device_id} --tags '{"country": "USA"}'
JSON ファイルのコンテンツを使用してデバイス ツイン タグにパッチを適用します。
az iot hub device-twin update -n {iothub_name} -d {device_id} --tags /path/to/file
親 'temperature' からの 'critical' 必要なプロパティの修正プログラムの削除
az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"condition":{"temperature":{"critical": null}}}'
必須のパラメーター
ターゲット デバイス ID。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。既定値は、 az configure --defaults iothub-data-auth-type={auth-type-value}
を使用して構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Access Control Arguments |
規定値: | key |
指定可能な値: | key, login |
ツインの必要なプロパティ。
プロパティ | 値 |
---|---|
Parameter group: | Twin Patch Arguments |
リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | False |
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
プロパティ | 値 |
---|---|
Parameter group: | IoT Hub Identifier Arguments |
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
Twin tags.
プロパティ | 値 |
---|---|
Parameter group: | Twin Patch Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |