az iot hub digital-twin
Note
このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot hub digital-twin コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
IoT Hub デバイスのデジタル ツインを操作して操作します。
コマンド
名前 | 説明 | 型 | Status |
---|---|---|---|
az iot hub digital-twin invoke-command |
デジタル ツイン デバイスのルートまたはコンポーネント レベルのコマンドを呼び出します。 |
拡張子 | GA |
az iot hub digital-twin show |
IoT Hub デバイスのデジタル ツインを表示します。 |
拡張子 | GA |
az iot hub digital-twin update |
JSON パッチ仕様を使用して、デジタル ツイン デバイスの読み取り/書き込みプロパティを更新します。 |
拡張子 | GA |
az iot hub digital-twin invoke-command
デジタル ツイン デバイスのルートまたはコンポーネント レベルのコマンドを呼び出します。
az iot hub digital-twin invoke-command --cn
--device-id
[--component-path]
[--connect-timeout]
[--hub-name]
[--login]
[--payload]
[--resource-group]
[--response-timeout]
例
一般に、インライン JSON を使用して特定のプロパティを含むペイロードを受け取るコマンドを呼び出します。
az iot hub digital-twin invoke-command --command-name {command_name} -n {iothub_name} -d {device_id} --payload '{"property_name": "property_value"}'
DTDL モデルに準拠する "delay" という名前のペイロードを受け取るルート レベル コマンド "reboot" を呼び出す https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/samples/TemperatureController.json.
az iot hub digital-twin invoke-command --command-name reboot -n {iothub_name} -d {device_id} --payload 5
入力を受け取っていないコンポーネント "thermostat1" でコマンド "getMaxMinReport" を呼び出します。
az iot hub digital-twin invoke-command --cn getMaxMinReport -n {iothub_name} -d {device_id} --component-path thermostat1
必須のパラメーター
デジタル ツイン コマンド名。
ターゲット デバイス ID。
省略可能のパラメーター
デジタル ツイン コンポーネントのパス。 例: thermostat1。
IoT Hub がデバイスへの接続を試行する最大時間 (秒単位)。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
コマンドの JSON ペイロード入力。 ファイル パスまたはインライン JSON を指定します。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
デジタル ツイン コマンドが結果を待機する最大時間 (秒単位)。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub digital-twin show
IoT Hub デバイスのデジタル ツインを表示します。
az iot hub digital-twin show --device-id
[--hub-name]
[--login]
[--resource-group]
例
ターゲット デバイスのデジタル ツインを表示します。
az iot hub digital-twin show -n {iothub_name} -d {device_id}
必須のパラメーター
ターゲット デバイス ID。
省略可能のパラメーター
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub digital-twin update
JSON パッチ仕様を使用して、デジタル ツイン デバイスの読み取り/書き込みプロパティを更新します。
現在、操作は追加、置換、削除に限定されています。
az iot hub digital-twin update --device-id
--json-patch
[--etag]
[--hub-name]
[--login]
[--resource-group]
例
JSON パッチ仕様を使用してデジタル ツインを更新します。
az iot hub digital-twin update --hub-name {iothub_name} --device-id {device_id} --json-patch '{"op":"add", "path":"/thermostat1/targetTemperature", "value": 54}'
JSON パッチ仕様を使用してデジタル ツインを更新します。
az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch '[
{"op":"remove", "path":"/thermostat1/targetTemperature"},
{"op":"add", "path":"/thermostat2/targetTemperature", "value": 22}
]'
ファイルで定義されている JSON パッチ仕様を使用して、デジタル ツイン プロパティを更新します。
az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch ./my/patch/document.json
必須のパラメーター
ターゲット デバイス ID。
JSON パッチで説明されている更新プログラムの仕様。 操作は、追加、置換、および削除に限定されます。 ファイル パスまたはインライン JSON を指定します。
省略可能のパラメーター
リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI