az iot hub device-twin

Note

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

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

Команды

Имя	Описание	Тип	Состояние
az iot hub device-twin list	Вывод списка двойников устройств в IoT Hub.	Extension	GA
az iot hub device-twin replace	Замените определение двойника устройства целевым json.	Extension	GA
az iot hub device-twin show	Получение определения двойника устройства.	Extension	GA
az iot hub device-twin update	Обновите нужные свойства и теги двойника устройства.	Extension	GA

az iot hub device-twin list

Вывод списка двойников устройств в IoT Hub.

Эта команда совпадает с запросом iot hub с запросом "select * from devices" для всех устройств и "select * from devices where capabilities.iotEdge = true" для пограничных устройств. Используйте az iot hub query для более мощных запросов на устройствах.

az iot hub device-twin list [--auth-type {key, login}]
                            [--edge-enabled --ee {false, true}]
                            [--hub-name]
                            [--login]
                            [--resource-group]
                            [--top]

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

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

--auth-type

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

Свойство	Значение
Группа параметров:	Access Control Arguments
Default value:	key
Допустимые значения:	key, login

--edge-enabled --ee

Флаг, указывающий включение ребра.

Свойство	Значение
Default value:	False
Допустимые значения:	false, true

--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--login -l

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

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--resource-group -g

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

--top

Максимальное количество возвращаемых элементов. Используйте -1 для неограниченного количества.

Свойство	Значение
Default value:	1000

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

--debug

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

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство	Значение
Default value:	False

--output -o

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

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

--query

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

--subscription

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

--verbose

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

Свойство	Значение
Default value:	False

az iot hub device-twin replace

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

Входной json напрямую или используйте путь к файлу.

az iot hub device-twin replace --device-id
                               --json
                               [--acquire-policy-token]
                               [--auth-type {key, login}]
                               [--change-reference]
                               [--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.

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

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

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--auth-type

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

Свойство	Значение
Группа параметров:	Access Control Arguments
Default value:	key
Допустимые значения:	key, login

--change-reference

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

Свойство	Значение
Группа параметров:	Global Policy Arguments

--etag -e

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

--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--login -l

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

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--resource-group -g

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

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

--debug

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

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство	Значение
Default value:	False

--output -o

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

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

--query

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

--subscription

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

--verbose

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

Свойство	Значение
Default value:	False

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}.

Свойство	Значение
Группа параметров:	Access Control Arguments
Default value:	key
Допустимые значения:	key, login

--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--login -l

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

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--resource-group -g

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

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

--debug

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

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство	Значение
Default value:	False

--output -o

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

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

--query

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

--subscription

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

--verbose

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

Свойство	Значение
Default value:	False

az iot hub device-twin update

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

Укажите аргументы --desired или --tags для поведения PATCH. Оба параметра поддерживают встроенный json или путь к содержимому json. Использование универсальных args (т. е. --set) отражает поведение PUT и не рекомендуется.

az iot hub device-twin update --device-id
                              [--acquire-policy-token]
                              [--add]
                              [--auth-type {key, login}]
                              [--change-reference]
                              [--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"}'

Исправление тегов двойника устройства с содержимым файла JSON.

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags /path/to/file

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

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

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

--device-id -d

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

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

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

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство	Значение
Группа параметров:	Global Policy Arguments

--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

Свойство	Значение
Группа параметров:	Generic Update Arguments
Default value:	[]

--auth-type

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

Свойство	Значение
Группа параметров:	Access Control Arguments
Default value:	key
Допустимые значения:	key, login

--change-reference

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

Свойство	Значение
Группа параметров:	Global Policy Arguments

--desired

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

Свойство	Значение
Группа параметров:	Twin Patch Arguments

--etag -e

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

--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Свойство	Значение
Группа параметров:	Generic Update Arguments
Default value:	False

--hub-name -n

IoT Hub имя или имя узла. Требуется, если --login не указан.

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--login -l

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

Свойство	Значение
Группа параметров:	IoT Hub Identifier Arguments

--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Свойство	Значение
Группа параметров:	Generic Update Arguments
Default value:	[]

--resource-group -g

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

--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

Свойство	Значение
Группа параметров:	Generic Update Arguments
Default value:	[]

--tags

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

Свойство	Значение
Группа параметров:	Twin Patch Arguments

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

--debug

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

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

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

Свойство	Значение
Default value:	False

--output -o

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

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

--query

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

--subscription

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

--verbose

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

Свойство	Значение
Default value:	False