az dt twin

Note

此参考是 Azure CLI（版本 2.67.0 或更高版本）的 azure-iot 扩展的一部分。 该扩展将在首次运行 az dt twin 命令时自动安装。 了解更多关于扩展的信息。

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

命令

名称	说明	类型	Status
az dt twin component	显示和更新数字孪生实例的数字孪生组件。	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	删除数字孪生实例中的所有数字孪生体，包括这些孪生体的所有关系。	Extension	GA
az dt twin query	查询实例的数字孪生体。 允许遍历关系并按属性值进行筛选。	Extension	GA
az dt twin relationship	管理和配置数字孪生实例的数字孪生关系。	Extension	GA
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 show	显示数字孪生体的详细信息。	Extension	GA
az dt twin telemetry	测试和验证数字孪生实例的事件路由和终结点。	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

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

--dtmi --model-id -m

数字孪生模型 ID。示例：dtmi：com：example：Room;2。

--twin-id -t

数字孪生 ID。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--if-none-match

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

属性	值
默认值:	False

--properties -p

用于实例化数字孪生或相关组件的初始属性值。 提供文件路径或内联 JSON。 包含组件的孪生体需要属性，至少必须为每个组件提供一个空$metadata对象。

--resource-group -g

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

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	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

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

--twin-id -t

数字孪生 ID。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--etag -e

实体标记值。 如果 etag 与资源的当前 etag 匹配，该命令将成功。

--resource-group -g

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

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	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

删除数字孪生实例中的所有数字孪生体，包括这些孪生体的所有关系。

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

示例

删除所有数字孪生体。 还将删除引用孪生体的任何关系。

az dt twin delete-all -n {instance_or_hostname}

必需参数

--dt-name --dtn -n

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--resource-group -g

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

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	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 的 shell 或 powershell 中，$ 字符具有功能意义，必须作为查询输入的一部分进行转义。 有关详细信息，请查看数字孪生 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

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

--query-command -q

要执行的用户查询。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--cost --show-cost

计算并显示查询费用。

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

--resource-group -g

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

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	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

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

--twin-id -t

数字孪生 ID。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--resource-group -g

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

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	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

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

--json-patch --patch

JSON 修补程序描述的更新规范。 对属性值和$model元素的更新可能在同一请求中发生。 作仅限于添加、替换和删除。 提供文件路径或内联 JSON。

--twin-id -t

数字孪生 ID。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--etag -e

实体标记值。 如果 etag 与资源的当前 etag 匹配，该命令将成功。

--resource-group -g

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

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	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