你当前正在访问 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 扩展的一部分,因此请按照以下步骤确保具有最新的 azure-iot 扩展和 az dt 命令。

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 及其完整的命令集: