Share via

az dt twin component

  • リファレンス

Note

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

Digital Twins インスタンスのデジタル ツイン コンポーネントを表示および更新します。

コマンド

名前 説明 型 Status
az dt twin component show

デジタル ツイン コンポーネントの詳細を表示します。

 拡張 GA
az dt twin component update

JSON パッチ仕様を使用してデジタル ツイン コンポーネントを更新します。

 拡張 GA

az dt twin component show

デジタル ツイン コンポーネントの詳細を表示します。

az dt twin component show --component
                          --dt-name
                          --twin-id
                          [--resource-group]

例

デジタル ツイン コンポーネントの詳細を表示する

az dt twin component show -n {instance_or_hostname} --twin-id {twin_id} --component Thermostat

必須のパラメーター

--component

DTDL コンポーネントへのパス。

--dt-name --dtn -n

Digital Twins インスタンス名またはホスト名。 インスタンス名が指定されている場合、ユーザー サブスクリプションは、最初にターゲット インスタンスに対してクエリを実行してホスト名を取得します。 ホスト名が指定されている場合、サブスクリプション クエリはスキップされ、指定された値は後続の操作に使用されます。

--twin-id -t

デジタル ツイン ID。

省略可能のパラメーター

--resource-group -g

Digital Twins インスタンス リソース グループ。 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 dt twin component update

JSON パッチ仕様を使用してデジタル ツイン コンポーネントを更新します。

プロパティ値と$model要素への更新は、同じ要求で発生する可能性があります。 操作は、追加、置換、および削除に限定されます。

az dt twin component update --component
                            --dt-name
                            --json-patch
                            --twin-id
                            [--etag]
                            [--resource-group]

例

JSON パッチ仕様を使用してデジタル ツイン コンポーネントを更新します。

az dt twin component update -n {instance_or_hostname} --twin-id {twin_id} --component {component_path} --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}'

JSON パッチ仕様を使用してデジタル ツイン コンポーネントを更新します。

az dt twin component update -n {instance_or_hostname} --twin-id {twin_id} --component {component_path} --json-patch '[
  {"op":"replace", "path":"/Temperature", "value": 20.5},
  {"op":"add", "path":"/Areas", "value": ["ControlSystem"]}
]'

ファイルで定義されている JSON パッチ仕様を使用して、デジタル ツイン コンポーネントを更新します。

az dt twin component update -n {instance_or_hostname} --twin-id {twin_id} --component {component_path} --json-patch ./my/patch/document.json

必須のパラメーター

--component

DTDL コンポーネントへのパス。

--dt-name --dtn -n

Digital Twins インスタンス名またはホスト名。 インスタンス名が指定されている場合、ユーザー サブスクリプションは、最初にターゲット インスタンスに対してクエリを実行してホスト名を取得します。 ホスト名が指定されている場合、サブスクリプション クエリはスキップされ、指定された値は後続の操作に使用されます。

--json-patch --patch

JSON パッチで説明されている更新プログラムの仕様。 プロパティ値と$model要素への更新は、同じ要求で発生する可能性があります。 操作は、追加、置換、および削除に限定されます。 ファイル パスまたはインライン JSON を指定します。

--twin-id -t

デジタル ツイン ID。

省略可能のパラメーター

--etag -e

エンティティ タグの値。 etag がリソースの現在の etag と一致する場合、コマンドは成功します。

--resource-group -g

Digital Twins インスタンス リソース グループ。 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 を使います。