az dt twin relationship

リファレンス

Note

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

Digital Twins インスタンスのデジタルツインリレーションシップを管理および構成します。

コマンド

名前	説明	型	Status
az dt twin relationship create	ソースとターゲットのデジタルツインの間にリレーションシップを作成します。	拡張子	GA
az dt twin relationship delete	Digital Twins インスタンスのデジタルツインリレーションシップを削除します。	拡張子	GA
az dt twin relationship delete-all	受信リレーションシップを含め、Digital Twins インスタンス内のすべてのデジタルツインリレーションシップを削除します。	拡張子	GA
az dt twin relationship list	デジタルツインのリレーションシップを一覧表示します。	拡張子	GA
az dt twin relationship show	デジタルツインリレーションシップの詳細を表示します。	拡張子	GA
az dt twin relationship update	JSON パッチ仕様を使用して、2 つのデジタルツイン間のリレーションシップのプロパティを更新します。	拡張子	GA

az dt twin relationship create

ソースとターゲットのデジタルツインの間にリレーションシップを作成します。

--properties には、インライン JSON またはファイルパスを指定できます。

az dt twin relationship create --dt-name
                               --kind
                               --relationship-id
                               --source
                               --target
                               [--if-none-match]
                               [--properties]
                               [--resource-group]

例

2 つのデジタルツイン間にリレーションシップを作成します。

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id}

if-none-match タグを使用して 2 つのデジタルツイン間のリレーションシップを作成する

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id} --if-none-match

2 つのデジタルツイン間に初期化されたプロパティを持つリレーションシップを作成します。

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id} --properties '{"ownershipUser": "me", "ownershipDepartment": "Computer Science"}'

必須のパラメーター

--dt-name --dtn -n

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

--kind --relationship

リレーションシップの名前または種類。例: 'contains'。

--relationship-id -r

リレーションシップ ID。

--source --twin-id -t

リレーションシップのソースツイン ID。

--target --target-twin-id

リレーションシップのターゲットツイン ID。

省略可能のパラメーター

--if-none-match

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

既定値: False

--properties -p

デジタルツインリレーションシップをインスタンス化するための初期プロパティ値。ファイルパスまたはインライン JSON を指定します。

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

Digital Twins インスタンスのデジタルツインリレーションシップを削除します。

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

例

デジタルツインリレーションシップを削除します。

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

etag を使用してデジタルツインリレーションシップを削除します。

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

必須のパラメーター

--dt-name --dtn -n

--relationship-id -r

リレーションシップ ID。

--source --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 を使います。

az dt twin relationship delete-all

受信リレーションシップを含め、Digital Twins インスタンス内のすべてのデジタルツインリレーションシップを削除します。

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

例

ツインに関連付けられているすべてのデジタルツインリレーションシップを削除します。

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

Digital Twins instace 内のすべてのデジタルツインリレーションシップを削除します。

az dt twin relationship delete-all -n {instance_or_hostname}

必須のパラメーター

--dt-name --dtn -n

省略可能のパラメーター

--resource-group -g

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

--source --twin-id -t

リレーションシップのソースツイン ID。

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバルパラメーター

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

デジタルツインのリレーションシップを一覧表示します。

az dt twin relationship list --dt-name
                             --source
                             [--incoming {false, true}]
                             [--kind]
                             [--resource-group]

例

デジタルツインの送信リレーションシップを一覧表示します。

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id}

デジタルツインの送信リレーションシップを一覧表示し、リレーションシップ 'contains' にフィルターを適用する

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --relationship contains

デジタルツインの受信リレーションシップを一覧表示します。

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --incoming

デジタルツインの受信リレーションシップを一覧表示し、リレーションシップ 'contains' でフィルター処理します。

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --relationship contains --incoming

必須のパラメーター

--dt-name --dtn -n

--source --twin-id -t

リレーションシップのソースツイン ID。

省略可能のパラメーター

--incoming

デジタルツインの受信リレーションシップをすべて取得します。

承認された値: false, true

既定値: False

--kind --relationship

リレーションシップの種類で結果をフィルター処理します。

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

デジタルツインリレーションシップの詳細を表示します。

az dt twin relationship show --dt-name
                             --relationship-id
                             --source
                             [--resource-group]

例

デジタルツインリレーションシップの詳細を表示します。

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

必須のパラメーター

--dt-name --dtn -n

--relationship-id -r

リレーションシップ ID。

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

JSON パッチ仕様を使用して、2 つのデジタルツイン間のリレーションシップのプロパティを更新します。

操作は、追加、置換、および削除に限定されます。

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

例

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

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

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

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

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

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

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

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

必須のパラメーター

--dt-name --dtn -n

--json-patch --patch

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

--relationship-id -r

リレーションシップ ID。

--source --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 を使います。

次の方法で共有

az dt twin relationship

コマンド

az dt twin relationship create

例

必須のパラメーター

省略可能のパラメーター

az dt twin relationship delete

例

必須のパラメーター

省略可能のパラメーター

az dt twin relationship delete-all

例

必須のパラメーター

省略可能のパラメーター

az dt twin relationship list

例

必須のパラメーター

省略可能のパラメーター

az dt twin relationship show

例

必須のパラメーター

省略可能のパラメーター

az dt twin relationship update

例

必須のパラメーター

省略可能のパラメーター

その他のリソース