az dt twin relationship

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). 该扩展会在首次运行 az dt twin relationship 命令时自动安装。 Learn more about extensions.

管理和配置数字孪生实例的数字孪生关系。

命令

名称	说明	类型	Status
az dt twin relationship create	在源和目标数字孪生之间创建关系。	Extension	GA
az dt twin relationship delete	删除数字孪生实例上的数字孪生关系。	Extension	GA
az dt twin relationship delete-all	删除数字孪生实例中的所有数字孪生关系，包括传入关系。	Extension	GA
az dt twin relationship list	列出数字孪生体的关系。	Extension	GA
az dt twin relationship show	显示数字孪生关系的详细信息。	Extension	GA
az dt twin relationship update	通过 JSON 修补程序规范更新两个数字孪生之间的关系的属性。	Extension	GA

az dt twin relationship create

在源和目标数字孪生之间创建关系。

--properties 可以是内联 JSON 或文件路径。

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

示例

在两个数字孪生体之间创建关系。

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 标记在两个数字孪生之间创建关系

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

在两个数字孪生之间创建具有初始化属性的关系。

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

数字孪生实例名称或主机名。 如果提供了实例名称，则首先查询目标实例的用户订阅以检索主机名。 如果提供了主机名，则会跳过订阅查询，并提供的值用于后续交互。

--kind --relationship

关系名称或类型。 例如：“contains”。

--relationship-id -r

Relationship Id.

--source --twin-id -t

关系的源孪生 ID。

--target --target-twin-id

关系的目标孪生 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。

--resource-group -g

数字孪生实例资源组。 可以使用 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 relationship delete

删除数字孪生实例上的数字孪生关系。

az dt twin relationship delete --dt-name --dtn
                               --relationship-id
                               --source --twin-id
                               [--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

Relationship Id.

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

数字孪生实例资源组。 可以使用 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 relationship delete-all

删除数字孪生实例中的所有数字孪生关系，包括传入关系。

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

示例

删除与孪生体关联的所有数字孪生关系。

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

删除数字孪生体内的所有数字孪生关系。

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

必需参数

--dt-name --dtn -n

数字孪生实例名称或主机名。 如果提供了实例名称，则首先查询目标实例的用户订阅以检索主机名。 如果提供了主机名，则会跳过订阅查询，并提供的值用于后续交互。

可选参数

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

数字孪生实例资源组。 可以使用 az configure --defaults group={name}配置默认组。

--source --twin-id -t

关系的源孪生 ID。

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

列出数字孪生体的关系。

az dt twin relationship list --dt-name --dtn
                             --source --twin-id
                             [--incoming {false, true}]
                             [--kind --relationship]
                             [--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。

可选参数

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

--incoming

检索数字孪生体的所有传入关系。

属性	值
默认值:	False
接受的值:	false, true

--kind --relationship

按关系类型筛选结果。

--resource-group -g

数字孪生实例资源组。 可以使用 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 relationship show

显示数字孪生关系的详细信息。

az dt twin relationship show --dt-name --dtn
                             --relationship-id
                             --source --twin-id
                             [--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

Relationship Id.

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

数字孪生实例资源组。 可以使用 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 relationship update

通过 JSON 修补程序规范更新两个数字孪生之间的关系的属性。

作仅限于添加、替换和删除。

az dt twin relationship update --dt-name --dtn
                               --json-patch --patch
                               --relationship-id
                               --source --twin-id
                               [--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

Relationship Id.

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

数字孪生实例资源组。 可以使用 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