az dt twin

Note

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

Digital Twins インスタンスのデジタル ツインを管理および構成します。

コマンド

名前	説明	型	状態
az dt twin component	Digital Twins インスタンスのデジタル ツイン コンポーネントを表示および更新します。	Extension	GA
az dt twin component show	デジタル ツイン コンポーネントの詳細を表示します。	Extension	GA
az dt twin component update	JSON パッチ仕様を使用してデジタル ツイン コンポーネントを更新します。	Extension	GA
az dt twin create	インスタンスにデジタル ツインを作成します。	Extension	GA
az dt twin delete	デジタル ツインを削除します。 このツインを参照するすべてのリレーションシップは既に削除されている必要があります。	Extension	GA
az dt twin delete-all	Digital Twins インスタンス内のすべてのデジタル ツイン (それらのツインのすべてのリレーションシップを含む) を削除します。	Extension	GA
az dt twin query	インスタンスのデジタル ツインに対してクエリを実行します。 リレーションシップの走査とプロパティ値によるフィルター処理を許可します。	Extension	GA
az dt twin relationship	Digital Twins インスタンスのデジタル ツインリレーションシップを管理および構成します。	Extension	GA
az dt twin relationship create	ソースとターゲットのデジタル ツインの間にリレーションシップを作成します。	Extension	GA
az dt twin relationship delete	Digital Twins インスタンスのデジタル ツインリレーションシップを削除します。	Extension	GA
az dt twin relationship delete-all	受信リレーションシップを含め、Digital Twins インスタンス内のすべてのデジタル ツイン リレーションシップを削除します。	Extension	GA
az dt twin relationship list	デジタル ツインのリレーションシップを一覧表示します。	Extension	GA
az dt twin relationship show	デジタル ツインリレーションシップの詳細を表示します。	Extension	GA
az dt twin relationship update	JSON パッチ仕様を使用して、2 つのデジタル ツイン間のリレーションシップのプロパティを更新します。	Extension	GA
az dt twin show	デジタル ツインの詳細を表示します。	Extension	GA
az dt twin telemetry	Digital Twins インスタンスのイベント ルートとエンドポイントをテストして検証します。	Extension	GA
az dt twin telemetry send	デジタル ツインに代わってテレメトリを送信します。 コンポーネント パスが指定されている場合、出力されるテレメトリはコンポーネントの代わりに使用されます。	Extension	GA
az dt twin update	JSON パッチ仕様を使用してインスタンス デジタル ツインを更新します。	Extension	GA

az dt twin create

インスタンスにデジタル ツインを作成します。

--properties には、インライン JSON またはファイル パスを指定できます。 注: --properties は、コンポーネントを含むツインに必要です。

az dt twin create --dt-name --dtn
                  --dtmi --model-id
                  --twin-id
                  [--if-none-match]
                  [--properties]
                  [--resource-group]

例

既存の (事前に作成された) モデルからデジタル ツインを作成します。

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id}

if-none-match タグを使用して、既存の (事前に作成された) モデルからデジタル ツインを作成します。

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id} --if-none-match

既存の (事前に作成された) モデルからデジタル ツインを作成します。 プロパティ値を指定してインスタンスを作成します。

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:DeviceInformation;1" --twin-id {twin_id} --properties '{"manufacturer": "Microsoft"}'

既存の (事前に作成された) モデルのコンポーネントを含むデジタル ツインを作成します。 最小プロパティを使用してコンポーネントをインスタンス化します。

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
    "Thermostat": {
        "$metadata": {},
    }
}'

既存の (事前に作成された) モデルのコンポーネントを含むデジタル ツインを作成します。 プロパティ値を指定してインスタンスを作成します。

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
    "Temperature": 10.2,
    "Thermostat": {
        "$metadata": {},
        "setPointTemp": 23.12
    }
}'

必須のパラメーター

--dt-name --dtn -n

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

--dtmi --model-id -m

Digital Twins モデル ID。例: dtmi:com:example:Room;2。

--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.

--if-none-match

同じ ID の既存のツインが存在する場合、作成操作が失敗する必要があることを示します。

プロパティ	値
規定値:	False

--properties -p

デジタル ツインまたは関連コンポーネントをインスタンス化するための初期プロパティ値。 ファイル パスまたはインライン JSON を指定します。 プロパティは、コンポーネントを含むツインに必要です。少なくとも、各コンポーネントに空の$metadata オブジェクトを指定する必要があります。

--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 delete

デジタル ツインを削除します。 このツインを参照するすべてのリレーションシップは既に削除されている必要があります。

az dt twin delete --dt-name --dtn
                  --twin-id
                  [--etag]
                  [--resource-group]

例

ID でデジタル ツインを削除します。

az dt twin delete -n {instance_or_hostname} --twin-id {twin_id}

etag を使用して ID でデジタル ツインを削除します。

az dt twin delete -n {instance_or_hostname} --twin-id {twin_id} --etag {etag}

必須のパラメーター

--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.

--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 delete-all

Digital Twins インスタンス内のすべてのデジタル ツイン (それらのツインのすべてのリレーションシップを含む) を削除します。

az dt twin delete-all --dt-name --dtn
                      [--resource-group]
                      [--yes]

例

すべてのデジタル ツインを削除します。 ツインを参照するすべてのリレーションシップも削除されます。

az dt twin delete-all -n {instance_or_hostname}

必須のパラメーター

--dt-name --dtn -n

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

省略可能のパラメーター

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}を使用して既定のグループを構成できます。

--yes -y

確認を求めないでください。

プロパティ	値
規定値:	False

グローバル パラメーター

--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 query

インスタンスのデジタル ツインに対してクエリを実行します。 リレーションシップの走査とプロパティ値によるフィルター処理を許可します。

多くのツイン クエリでは、ツインの $ プロパティを参照するために $dtId 文字が使用されます。 bash のようなシェルまたは powershell では、$ 文字は機能的な意味を持ち、クエリ入力の一部としてエスケープする必要があります。 詳細については、Digital Twins CLI の概念に関するドキュメント https://learn.microsoft.com/en-us/azure/digital-twins/concepts-cli を参照してください。

az dt twin query --dt-name --dtn
                 --query-command
                 [--cost --show-cost {false, true}]
                 [--resource-group]

例

ターゲット インスタンスですべてのデジタル ツインのクエリを実行し、すべての属性を投影します。 また、クエリ単位でコストを表示します。

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins" --show-cost

モデルでクエリを実行し、すべての属性を投影します。

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins T where IS_OF_MODEL(T, 'dtmi:com:example:Room;2')"

bash 互換構文で '$dtId' を利用するクエリ

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.\$dtId = 'room0'"

powershell 互換構文を使用した '$dtId' を利用したクエリ

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.`$dtId = 'room0'"

必須のパラメーター

--dt-name --dtn -n

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

--query-command -q

実行するユーザー クエリ。

省略可能のパラメーター

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

--cost --show-cost

クエリの料金を計算して表示します。

プロパティ	値
規定値:	False
指定可能な値:	false, true

--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 show

デジタル ツインの詳細を表示します。

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

例

デジタル ツインの詳細を表示します。

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

必須のパラメーター

--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 update

JSON パッチ仕様を使用してインスタンス デジタル ツインを更新します。

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

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

例

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

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

JSON パッチ仕様と etag を使用してデジタル ツインを更新します。

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

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

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

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

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

必須のパラメーター

--dt-name --dtn -n

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

--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