az iot hub device-twin

Примечание

Эта ссылка является частью расширения Azure-IOT для Azure CLI и требует версии 2.17.1 или более поздней. Расширение будет автоматически установлено при первом запуске команды AZ IOT Hub Device-двойника . Подробнее о расширениях.

Управление конфигурацией двойника для устройств IoT.

Команды

az iot hub device-twin replace

Замените определение двойникаа устройства на конечный JSON.

az iot hub device-twin show

Получите определение двойникаа устройства.

az iot hub device-twin update

Обновите требуемые свойства и теги двойникаа устройства.

az iot hub device-twin replace

Замените определение двойникаа устройства на конечный JSON.

Введите JSON непосредственно или используйте путь к файлу.

az iot hub device-twin replace --device-id
                               --json
                               [--auth-type {key, login}]
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Примеры

Замените двойника устройства на содержимое файла.

az iot hub device-twin replace -d {device_id} -n {iothub_name} -j ../mydevicetwin.json

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

--device-id -d

Целевое устройство.

--json -j

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

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

--auth-type

Указывает, должна ли операция выполнять автоматический производный ключ политики или использовать текущий сеанс Azure AD. Можно настроить по умолчанию с помощью az configure --defaults iothub-data-auth-type=<auth-type-value> .

допустимые значения: key, login
значение по умолчанию: key
--etag -e

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

--hub-name -n

Имя центра Интернета вещей.

--login -l

Эта команда поддерживает строку подключения сущности с правами на выполнение действия. Используйте, чтобы избежать сеанса входа в сеанс с помощью команды AZ Login. Если заданы строка подключения и имя сущности, то строка соединения имеет приоритет.

--resource-group -g

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

az iot hub device-twin show

Получите определение двойникаа устройства.

az iot hub device-twin show --device-id
                            [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]

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

--device-id -d

Целевое устройство.

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

--auth-type

Указывает, должна ли операция выполнять автоматический производный ключ политики или использовать текущий сеанс Azure AD. Можно настроить по умолчанию с помощью az configure --defaults iothub-data-auth-type=<auth-type-value> .

допустимые значения: key, login
значение по умолчанию: key
--hub-name -n

Имя центра Интернета вещей.

--login -l

Эта команда поддерживает строку подключения сущности с правами на выполнение действия. Используйте, чтобы избежать сеанса входа в сеанс с помощью команды AZ Login. Если заданы строка подключения и имя сущности, то строка соединения имеет приоритет.

--resource-group -g

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

az iot hub device-twin update

Обновите требуемые свойства и теги двойникаа устройства.

Укажите аргументы--необходимые или--теги для поведения исправления. Использование универсальных аргументов обновления (т. е. набора) будет отражать поведение вставки и является устаревшим.

az iot hub device-twin update --device-id
                              [--add]
                              [--auth-type {key, login}]
                              [--desired]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--tags]

Примеры

Задвойника требуемые свойства устройства.

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'

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

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags '{"country": "USA"}'

Удаление исправления "критического" требуемого свойства из родительского элемента "температура"

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"condition":{"temperature":{"critical": null}}}'

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

--device-id -d

Целевое устройство.

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

--add

Добавьте объект в список объектов, указав путь и пары "ключ-значение". Пример:--добавить свойство. Листпроперти <ключ = значение, строка или строка JSON>.

--auth-type

Указывает, должна ли операция выполнять автоматический производный ключ политики или использовать текущий сеанс Azure AD. Можно настроить по умолчанию с помощью az configure --defaults iothub-data-auth-type=<auth-type-value> .

допустимые значения: key, login
значение по умолчанию: key
--desired

Требуемые свойства двойника.

--etag -e

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

--force-string

При использовании "Set" или "Add" сохраните строковые литералы вместо того, чтобы пытаться преобразовать их в JSON.

--hub-name -n

Имя центра Интернета вещей.

--login -l

Эта команда поддерживает строку подключения сущности с правами на выполнение действия. Используйте, чтобы избежать сеанса входа в сеанс с помощью команды AZ Login. Если заданы строка подключения и имя сущности, то строка соединения имеет приоритет.

--remove

Удаление свойства или элемента из списка. Пример:--Remove Property. List или--Remove пропертиторемове.

--resource-group -g

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

--set

Обновите объект, указав путь к свойству и значение, которое необходимо задать. Пример:--Set свойство1. свойство2 =.

--tags

Теги двойника.