Поделиться через

az iot hub digital-twin

  • Ссылка

Примечание.

Эта ссылка является частью расширения Azure-iot для Azure CLI (версия 2.46.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az iot hub digital-twin . Подробнее о расширениях.

Управляйте цифровым двойником Центр Интернета вещей устройства и взаимодействуйте с ним.

Команды

Имя Описание Тип Состояние
az iot hub digital-twin invoke-command

Вызов команды корневого или компонента устройства цифрового двойника.

 Расширение Общедоступная версия
az iot hub digital-twin show

Отображение цифрового двойника устройства Центр Интернета вещей.

 Расширение Общедоступная версия
az iot hub digital-twin update

Обновите свойства устройства цифрового двойника с помощью спецификации исправления JSON.

 Расширение Общедоступная версия

az iot hub digital-twin invoke-command

Вызов команды корневого или компонента устройства цифрового двойника.

az iot hub digital-twin invoke-command --cn
                                       --device-id
                                       [--component-path]
                                       [--connect-timeout]
                                       [--hub-name]
                                       [--login]
                                       [--payload]
                                       [--resource-group]
                                       [--response-timeout]

Примеры

Как правило, вызовите команду, которая принимает полезные данные, включающие определенное свойство с помощью встроенного JSON.

az iot hub digital-twin invoke-command --command-name {command_name} -n {iothub_name} -d {device_id} --payload '{"property_name": "property_value"}'

Вызов команды корневого уровня "перезагрузка", которая принимает полезные данные с именем "задержка", соответствующую модели DTDL https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/samples/TemperatureController.json.

az iot hub digital-twin invoke-command --command-name reboot -n {iothub_name} -d {device_id} --payload 5

Вызовите команду getMaxMinReport для компонента "thermostat1", который не принимает входных данных.

az iot hub digital-twin invoke-command --cn getMaxMinReport -n {iothub_name} -d {device_id} --component-path thermostat1

Обязательные параметры

--cn --command-name

Имя команды цифрового двойника.

--device-id -d

Идентификатор целевого устройства.

Необязательные параметры

--component-path

Путь к компоненту цифрового двойника. Например: термостат1.

--connect-timeout --cto

Максимальный интервал времени в секундах, Центр Интернета вещей попытается подключиться к устройству.

--hub-name -n

Центр Интернета вещей имя или имя узла. Требуется, если --login не указан.

--login -l

Эта команда поддерживает сущность строка подключения с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если строка подключения сущности и имя указаны, строка подключения имеет приоритет. Требуется, если имя --hub-name не указано.

--payload

Входные данные полезных данных JSON для команды. Укажите путь к файлу или встроенный JSON.

Default value: {}
--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--response-timeout --rto

Максимальный интервал времени в секундах, в течение которой команда цифрового двойника ожидает результата.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az iot hub digital-twin show

Отображение цифрового двойника устройства Центр Интернета вещей.

az iot hub digital-twin show --device-id
                             [--hub-name]
                             [--login]
                             [--resource-group]

Примеры

Отображение цифрового двойника целевого устройства.

az iot hub digital-twin show -n {iothub_name} -d {device_id}

Обязательные параметры

--device-id -d

Идентификатор целевого устройства.

Необязательные параметры

--hub-name -n

Центр Интернета вещей имя или имя узла. Требуется, если --login не указан.

--login -l

Эта команда поддерживает сущность строка подключения с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если строка подключения сущности и имя указаны, строка подключения имеет приоритет. Требуется, если имя --hub-name не указано.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az iot hub digital-twin update

Обновите свойства устройства цифрового двойника с помощью спецификации исправления JSON.

В настоящее время операции ограничены добавлением, заменой и удалением.

az iot hub digital-twin update --device-id
                               --json-patch
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Примеры

Обновите цифровой двойник с помощью спецификации исправлений JSON.

az iot hub digital-twin update --hub-name {iothub_name} --device-id {device_id} --json-patch '{"op":"add", "path":"/thermostat1/targetTemperature", "value": 54}'

Обновите цифровой двойник с помощью спецификации исправлений JSON.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch '[
  {"op":"remove", "path":"/thermostat1/targetTemperature"},
  {"op":"add", "path":"/thermostat2/targetTemperature", "value": 22}
]'

Обновите свойство цифрового двойника с помощью спецификации исправлений JSON, определенной в файле.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch ./my/patch/document.json

Обязательные параметры

--device-id -d

Идентификатор целевого устройства.

--json-patch --patch

Спецификация обновления, описанная в формате JSON-patch. Операции ограничены добавлением, заменой и удалением. Укажите путь к файлу или встроенный JSON.

Необязательные параметры

--etag -e

Тег Etag или сущности, соответствующий последнему состоянию ресурса. Если etag не указан, используется значение "*".

--hub-name -n

Центр Интернета вещей имя или имя узла. Требуется, если --login не указан.

--login -l

Эта команда поддерживает сущность строка подключения с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если строка подключения сущности и имя указаны, строка подключения имеет приоритет. Требуется, если имя --hub-name не указано.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.