你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az dt twin relationship

备注

此参考是 Azure CLI (2.30.0 或更高版本) 的 azure-iot 扩展的一部分。 首次运行 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

通过 JSON 修补规范汇报两个数字孪生之间的关系的属性。

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]

示例

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

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

关系 ID。

--source --twin-id -t

关系的源孪生 ID。

--target --target-twin-id

关系的目标孪生 ID。

可选参数

--if-none-match

指示如果存在具有相同 ID 的现有孪生体,则创建操作应失败。

--properties -p

用于实例化数字孪生关系的初始属性值。 提供文件路径或内联 JSON。

--resource-group -g

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

az dt twin relationship delete

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

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

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

az dt twin relationship delete-all

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

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}

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

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

必需参数

--dt-name --dtn -n

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

可选参数

--resource-group -g

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

--source --twin-id -t

关系的源孪生 ID。

--yes -y

不提示确认。

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

按关系类型筛选结果。

--resource-group -g

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

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

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

az dt twin relationship update

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

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

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

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