Набор команд CLI для Azure Digital Twins

Помимо управления экземпляром Azure Digital Twins на портале Azure, Azure Digital Twins также имеет набор команд для Azure CLI , который можно использовать для выполнения большинства основных действий со службой. В этой статье описывается набор команд Azure CLI для Azure Digital Twins, включая его использование, получение и требования к использованию.

Некоторые действия, которые можно выполнить с помощью набора команд, включают:

• Управление экземпляром Azure Digital Twins
• Управление моделями
• Управление цифровыми двойниками
• Управление отношениями близнецов
• Настройка конечных точек
• Управление маршрутами
• Настройка безопасности с помощью управления доступом на основе ролей Azure (Azure RBAC)

Набор команд называется az dt, и он входит в расширение Azure IoT для Azure CLI. Полный список команд, а также сведения об их использовании см. в справочной документации по набору команд az iot: справочник по командам az dt.

Использование (развертывание и проверка)

Помимо общего управления экземпляром, интерфейс командной строки также является полезным средством для развертывания и проверки.

• С помощью команд уровня управления можно сделать развертывание нового экземпляра повторяющимся или автоматическим.
• С помощью команд плоскости данных можно быстро проверить значения в экземпляре и правильность выполнения операций.

Получите набор команд

Команды Azure Digital Twins являются частью расширения Azure IoT для Azure CLI (azure-iot), поэтому выполните следующие шаги, чтобы убедиться, что у вас установлено последнее расширение с необходимыми командами.

Требования к версии CLI

Если вы используете Azure CLI с PowerShell, ваша версия Azure CLI должна быть 2.3.1 или больше в качестве требования пакета расширения.

Вы можете проверить версию Azure CLI с помощью этой команды CLI:

az --version

Инструкции по установке или обновлению Azure CLI до более новой версии см. в статье "Установка Azure CLI".

Установите расширение

Azure CLI автоматически запрашивает установку расширения при первом использовании команды, требующей ее.

В противном случае можно использовать следующую команду, чтобы установить расширение самостоятельно (или обновить его, если вы уже получили более раннюю версию). Команда может выполняться в Azure Cloud Shell или локальном интерфейсе командной строки Azure.

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

Использование специальных символов в разных оболочках

Некоторые az dt команды используют специальные символы, которые могут быть экранированы для правильного анализа в определенных средах оболочки. Используйте советы в этом разделе, чтобы определить, когда следует экранировать специальные символы в оболочке по выбору.

Бить

Используйте эти советы по использованию специальных символов в средах Bash.

Запросы

Во многих запросах двойников символ $ используется для ссылки на свойство $dtId двойника. При использовании команды az dt twin query для запроса в среде Cloud Shell Bash экранируйте $ символ с обратной косой чертой (\).

Ниже приведен пример запроса двойника с помощью команды CLI в среде Cloud Shell Bash:

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. При вводе встроенного JSON в среде PowerShell экранируйте двойные кавычки (") внутри JSON с обратной косой чертой (\).

Ниже приведен пример создания двойника с помощью команды CLI в PowerShell:

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

Запросы

Во многих запросах двойников символ $ используется для ссылки на свойство $dtId двойника. При использовании команды az dt twin query для запроса в среде PowerShell экранируйте символ $ обратной кавычкой.

Ниже приведен пример запроса двойника с помощью команды CLI в PowerShell:

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

Командная строка Windows

Используйте эти подсказки по использованию специальных символов для локального Windows CMD.

Встроенный JSON

Некоторые команды, например az dt twin create, позволяют вводить сведения о двойниках в виде встроенного JSON. При вводе встроенного JSON в локальном окне CMD Windows заключите значение параметра в двойные кавычки (") вместо одинарных кавычек ('), а также экранируйте двойные кавычки внутри JSON при помощи обратной косой черты (\).

Ниже приведен пример создания двойника с помощью команды CLI в локальном cmD Windows:

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

Дальнейшие действия

Изучите интерфейс командной строки и полный набор команд с помощью справочных документов:

• az dt справочник команд