共用方式為

Azure Digital Twins CLI 命令集

  • 發行項

除了在 Azure 入口網站中管理 Azure Digital Twins 執行個體之外，Azure Digital Twins 還具有 Azure CLI 命令集，可讓您用來對服務執行大部分的主要動作。 本文涵蓋適用於 Azure Digital Twins 的 Azure CLI 命令集，包括其用途、如何取得，以及使用需求。

您可以使用命令集執行的部分動作包括：

  • 管理 Azure Digital Twins 執行個體
  • 管理模型
  • 管理數位對應項
  • 管理對應項關聯性
  • 設定端點
  • 管理路由
  • 透過 Azure 角色型存取控制 (Azure RBAC) 設定安全性

命令集稱為 az dt，且為適用於 Azure CLI 的 Azure IoT 延伸模組一部分。 您可以在 az iot 命令集的參考文件中，檢視命令的完整清單及其使用方式：az dt command reference。

使用 (部署和驗證)

除了一般的執行個體管理之外，CLI 亦為適用於部署與驗證的實用工具。

  • 控制平面命令可用來重複或自動化部署新執行個體。
  • 資料平面命令可用來快速檢查執行個體中的值，並確認作業是否如預期般完成。

取得命令集

Azure Digital Twins 命令是 適用於 Azure CLI 的 Azure IoT 擴充功能 (azure-iot) 的一部分，因此請遵循下列步驟，確定您具有具有命令的最新azure-iot擴充功能az dt。

CLI 版本需求

如果您使用 PowerShell 的 Azure CLI，您的 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

在不同的殼層中使用特殊字元

部份 az dt 命令會使用可能必須逸出的特殊字元，在特定殼層環境中進行適當的剖析。 透過本節中的提示幫助您了解何時要在您選擇的殼層中執行這項操作。

Bash

針對 Bash 環境使用這些特殊字元提示。

查詢

在多個對應項查詢中，$ 字元是用來參考對應項的 $dtId 屬性。 使用 az dt 對應項查詢命令在 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 對應項建立，可讓您以內嵌 JSON 的形式輸入對應項資訊。 在 PowerShell 環境中輸入內嵌 JSON 時，請使用反斜線 (\) 逸出 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 的命令也支援輸入做為檔案路徑，這可協助您避免殼層特定的文字需求。

查詢

在多個對應項查詢中，$ 字元是用來參考對應項的 $dtId 屬性。 使用 az dt 對應項查詢命令在 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 對應項建立，可讓您以內嵌 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 的命令也支援輸入做為檔案路徑，這可協助您避免殼層特定的文字需求。

下一步

透過參考文件探索 CLI 及其完整的命令集：