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

Azure 数字孪生 CLI 命令集

  • 项目

除了在 Azure 门户中管理 Azure 数字孪生实例外，还可以使用 Azure 数字孪生为 Azure CLI 提供的命令集对服务执行大多数主要操作。 本文介绍用于 Azure 数字孪生体的 Azure CLI 命令集，包括它的用途、获取方法及其使用要求。

可使用命令集来执行的一些操作包括：

  • 管理 Azure 数字孪生实例
  • 管理模型
  • 管理数字孪生体
  • 管理孪生关系
  • 配置终结点
  • 管理路由
  • 通过 Azure 基于角色的访问控制 (Azure RBAC) 配置安全性

命令集称为 az dt，是 Azure CLI 的 Azure IoT 扩展的一部分。 可以在 az iot 命令集的参考文档中查看完整的命令列表及其用法：az dt 命令参考。

使用（部署和验证）

除了通常情况下对实例进行管理外，CLI 还是一个用于部署和验证的有用工具。

  • 可使用控制平面命令重复部署或自动部署新的实例。
  • 可使用数据平面命令快速检查实例中的值，并验证操作是否按预期完成。

获取命令集

Azure 数字孪生命令是适用于 Azure CLI 的 Azure IoT 扩展 (azure-iot) 的一部分，因此请按照以下步骤操作，以确保使用 az dt 命令获得最新 azure-iot 扩展。

CLI 版本要求

如果要将 Azure CLI 与 PowerShell 配合使用，则扩展包的要求是，Azure CLI 版本应为 2.3.1 或更高版本。

可以使用以下 CLI 命令检查 Azure CLI 的版本：

az --version

有关如何将 Azure CLI 安装或更新为更新版本的说明，请参阅安装 Azure CLI。

获取扩展

首次使用需要扩展的命令时，Azure CLI 会自动提示你安装该扩展。

否则，可以使用以下命令随时自行安装扩展（或在你已有较旧版本的情况下对其进行更新）。 命令可以在 Azure Cloud Shell 或本地 Azure CLI 中运行。

az extension add --upgrade --name azure-iot

在不同的 shell 中使用特殊字符

一些 az dt 命令使用了特殊字符，在某些 shell 环境中可能需要转义才能正确地解析。 使用本部分中的提示可帮助你了解何时在所选 shell 中执行此操作。

Bash

在 Bash 环境使用这些特殊字符提示。

查询

在许多孪生体查询中，$ 字符用于引用孪生体的 $dtId 属性。 使用 az dt twin query 命令在 Cloud Shell Bash 环境中查询时，请使用反斜杠 (\) 来转义 $ 字符。

下面的示例展示了如何在 Cloud Shell Bash 环境中使用 CLI 命令查询孪生体：

az dt twin query --dt-name <instance-hostname-or-name> --query-command "SELECT * FROM DigitalTwins T Where T.\$dtId = 'room0'"

PowerShell

在 PowerShell 环境中使用这些特殊字符提示。

内联 JSON

一些命令（如 az dt twin create）允许以内联 JSON 形式输入孪生体信息。 在 PowerShell 环境中输入内联 JSON 时，请使用反斜杠 (\) 来转义双引号字符 (")。

下面的示例展示了如何在 PowerShell 中使用 CLI 命令创建孪生体：

az dt twin create --dt-name <instance-hostname-or-name> --dtmi "dtmi:contosocom:DigitalTwins:Thermostat;1" --twin-id thermostat67 --properties '{\"Temperature\": 0.0}'

提示

许多支持内联 JSON 的命令也支持作为文件路径输入，这有助于避免特定于 shell 的文本要求。

查询

在许多孪生体查询中，$ 字符用于引用孪生体的 $dtId 属性。 使用 az dt twin query 命令在 PowerShell 环境中查询时，请使用反引号字符来转义 $ 字符。

下面的示例展示了如何在 PowerShell 中使用 CLI 命令查询孪生体：

az dt twin query --dt-name <instance-hostname-or-name> --query-command "SELECT * FROM DigitalTwins T Where T.`$dtId = 'room0'"

Windows CMD

在本地 Windows CMD 中使用这些特殊字符提示。

内联 JSON

一些命令（如 az dt twin create）允许以内联 JSON 形式输入孪生体信息。 在本地 Windows CMD 窗口中输入内联 JSON 时，请用双引号 (") 而不是单引号 (') 将参数值括起来，并使用反斜杠 (\) 来转义 JSON 中的双引号字符。

下面的示例展示了如何在本地 Windows CMD 中使用 CLI 命令创建孪生体：

az dt twin create --dt-name <instance-hostname-or-name> --dtmi "dtmi:contosocom:DigitalTwins:Thermostat;1" --twin-id thermostat67 --properties "{\"Temperature\": 0.0}"

提示

许多支持内联 JSON 的命令也支持作为文件路径输入，这有助于避免特定于 shell 的文本要求。

后续步骤

通过参考文档了解 CLI 及其完整的命令集：