az dt twin component

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). 拡張機能は、az dt twin component コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.

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

コマンド

名前	説明	型	状態
az dt twin component show	デジタルツインコンポーネントの詳細を表示します。	Extension	GA
az dt twin component update	JSON パッチ仕様を使用してデジタルツインコンポーネントを更新します。	Extension	GA

az dt twin component show

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

az dt twin component show --component
                          --dt-name --dtn
                          --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。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Digital Twins インスタンスリソースグループ。 az configure --defaults group={name}を使用して既定のグループを構成できます。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az dt twin component update

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

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

az dt twin component update --component
                            --dt-name --dtn
                            --json-patch --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

--json-patch --patch

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

--twin-id -t

デジタルツイン ID。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--etag -e

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

--resource-group -g

Digital Twins インスタンスリソースグループ。 az configure --defaults group={name}を使用して既定のグループを構成できます。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

次の方法で共有

az dt twin component

コマンド

az dt twin component show

例

必須のパラメーター

省略可能のパラメーター

az dt twin component update

例

必須のパラメーター

省略可能のパラメーター

フィードバック