Набор команд 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 для Azure CLI. Полный список команд, а также сведения об их использовании см. в справочной документации по набору команд az iot: справочник по командам az dt.
Использование (развертывание и проверка)
Интерфейс командной строки позволяет не только управлять экземпляром, но и выполнять развертывание и проверку.
- С помощью команд уровня управления можно сделать развертывание нового экземпляра повторяющимся или автоматическим.
- С помощью команд плоскости данных можно быстро проверить значения в экземпляре и правильность выполнения операций.
Получение набора команд
Команды Azure Digital Twins являются частью расширения Azure IoT для Azure CLI (azure-iot), поэтому выполните следующие действия, чтобы убедиться, что у вас есть последнее azure-iot расширение с az dt командами.
Требования к версиям интерфейса командной строки
Если вы используете Azure CLI с PowerShell, используемая версия Azure CLI должна быть 2.3.1 или выше в соответствии с требованиями пакета расширения.
Чтобы проверить версию 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 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}'
Совет
Многие команды, поддерживающие встроенный КОД JSON, также поддерживают входные данные в качестве пути к файлу, что может помочь избежать требований к тексту, характерным для оболочки.
Запросы
Во многих запросах $ двойника символ используется для ссылки на $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'"
CMD (Windows)
Используйте эти специальные советы по символам для локального cmd Windows.
Встроенный КОД JSON
Некоторые команды, например az dt twin create, позволяют вводить сведения о двойниках в виде встроенного JSON. При вводе встроенного JSON в локальном окне WINDOWS CMD заключите значение параметра в двойные кавычки (") вместо одинарных кавычек (') и экранируйте символы двойных кавычек внутри JSON с обратной косой чертой (\).
Ниже приведен пример создания двойника с помощью команды CLI в локальном windows CMD:
az dt twin create --dt-name <instance-hostname-or-name> --dtmi "dtmi:contosocom:DigitalTwins:Thermostat;1" --twin-id thermostat67 --properties "{\"Temperature\": 0.0}"
Совет
Многие команды, поддерживающие встроенный КОД JSON, также поддерживают входные данные в качестве пути к файлу, что может помочь избежать требований к тексту, характерным для оболочки.
Дальнейшие действия
Ознакомьтесь со справочной документацией, чтобы изучить интерфейс командной строки и полный набор его команд: