az iot hub digital-twin

リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。拡張機能は、az iot hub digital-twin コマンドを初めて実行するときに自動的にインストールされます。拡張機能の詳細をご覧ください。

IoT Hub デバイスのデジタルツインを操作して操作します。

コマンド

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

必須のパラメーター

--cn --command-name

デジタルツインコマンド名。

--device-id -d

ターゲットデバイス ID。

省略可能のパラメーター

--component-path

デジタルツインコンポーネントのパス。例: thermostat1。

--connect-timeout --cto

IoT Hub がデバイスへの接続を試行する最大時間 (秒単位)。

--hub-name -n

IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。

--login -l

このコマンドは、アクションを実行する権限を持つエンティティ接続文字列をサポートします。 "az login" によるセッションログインを回避するために使用します。エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。

--payload

コマンドの JSON ペイロード入力。ファイルパスまたはインライン JSON を指定します。

規定値: {}

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--response-timeout --rto

デジタルツインコマンドが結果を待機する最大時間 (秒単位)。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --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}

必須のパラメーター

--device-id -d

ターゲットデバイス ID。

省略可能のパラメーター

--hub-name -n

IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。

--login -l

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --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

必須のパラメーター

--device-id -d

ターゲットデバイス ID。

--json-patch --patch

JSON パッチで説明されている更新プログラムの仕様。操作は、追加、置換、および削除に限定されます。ファイルパスまたはインライン JSON を指定します。

省略可能のパラメーター

--etag -e

リソースの最後の状態に対応する Etag またはエンティティタグ。 etag が指定されていない場合は、値 '*' が使用されます。

--hub-name -n

IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。

--login -l

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

次の方法で共有

az iot hub digital-twin

コマンド

az iot hub digital-twin invoke-command

例

必須のパラメーター

省略可能のパラメーター

az iot hub digital-twin show

例

必須のパラメーター

省略可能のパラメーター

az iot hub digital-twin update

例

必須のパラメーター

省略可能のパラメーター

その他のリソース