az iot hub configuration

Примечание.

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

Реализовано управление конфигурацией автоматического управления устройствами в центре Интернета вещей в большом масштабе.

Команды

Имя	Описание	Тип	Состояние
az iot hub configuration create	Создайте конфигурацию автоматического управления устройствами Интернета вещей в целевой Центр Интернета вещей.	Расширение	Общедоступная версия
az iot hub configuration delete	Удаление конфигурации устройства Интернета вещей.	Расширение	Общедоступная версия
az iot hub configuration list	Вывод списка конфигураций автоматического управления устройствами IoT в Центр Интернета вещей.	Расширение	Общедоступная версия
az iot hub configuration show	Получите сведения о конфигурации автоматического управления устройствами Интернета вещей.	Расширение	Общедоступная версия
az iot hub configuration show-metric	Оцените целевой пользователь или системную метрику, определенную в конфигурации устройства Интернета вещей.	Расширение	Общедоступная версия
az iot hub configuration update	Обновите указанные свойства конфигурации автоматического управления устройствами Интернета вещей.	Расширение	Общедоступная версия

az iot hub configuration create

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

Содержимое конфигурации — json и незначительно зависит от намерения устройства или модуля.

Конфигурации устройств находятся в виде {"deviceContent":{...}} или {"content":{"deviceContent":{...}}

Конфигурации модулей находятся в виде {"moduleContent":{...}} или {"content":{"moduleContent":{...}}

Конфигурации можно определить с предоставленными пользователем метриками для оценки по запросу. Пользовательские метрики — json и в виде {"запросы":{...}} или {"метрики":{"запросы":{...}}.

Примечание. Целевое условие для модулей должно начинаться с "с устройств.modules".

az iot hub configuration create --config-id
                                --content
                                [--auth-type {key, login}]
                                [--cl]
                                [--cmq]
                                [--hub-name]
                                [--lab]
                                [--login]
                                [--metrics]
                                [--pri]
                                [--resource-group]
                                [--target-condition]

Примеры

Создайте конфигурацию устройства с приоритетом 3, которая применяется при условии, когда устройство помечено в сборке 9, а среда — test.

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Создайте конфигурацию устройства с метками и укажите встроенные метрики пользователей (пример синтаксиса bash).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9" --labels '{"key0":"value0", "key1":"value1"}' --priority 10 --metrics '{"metrics": {"queries": {"mymetric": "select deviceId from devices where tags.location='US'"}}}'

Создайте конфигурацию модуля с метками и укажите встроенные метрики пользователей (пример синтаксиса cmd)

az iot hub configuration create -c {config_name} -n {iothub_name} --content module_content.json --target-condition "from devices.modules where tags.building=9" --labels "{\"key0\":\"value0\", \"key1\":\"value1\"}" --metrics "{\"metrics\": {\"queries\": {\"mymetric\": \"select moduleId from devices.modules where tags.location='US'\"}}}"

Создайте конфигурацию модуля с встроенными содержимым и пользовательскими метриками (пример синтаксиса PowerShell).

az iot hub configuration create -c {config_name} -n {iothub_name} --content '{\"moduleContent\": {\"properties.desired.chillerWaterSettings\": {\"temperature\": 38, \"pressure\": 78}}}' --target-condition "from devices.modules where tags.building=9" --priority 1 --metrics '{\"metrics\": {\"queries\": {\"mymetric\":\"select moduleId from devices.modules where tags.location=''US''\"}}}'

Создайте конфигурацию устройства с альтернативным стилем входных данных меток и метрик (не зависят от оболочки).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "from devices.modules where tags.building=9" --custom-labels key0="value0" key1="value1" --priority 10 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

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

--config-id -c

Имя конфигурации целевого устройства. Строчные регистры и следующие специальные символы разрешены: [-+%_*!].

--content -k

Содержимое конфигурации устройства. Укажите путь к файлу или необработанный json.

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

--auth-type

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

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

значение по умолчанию: key

--cl --custom-labels

Альтернативный стиль входных данных (пары key=value пробела) для меток --labels и предназначен для его замены в будущем. Пример формата: key1=value1 key2="это мое значение".

--cmq --custom-metric-queries

Альтернативный стиль ввода (пары "ключ=значение" пробела) для метрик --metrics и предназначен для замены его в будущем. Пример формата: metric1="select deviceId from devices where tags.location='US'" metric2="select *".

--hub-name -n

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

--lab --labels

Сопоставление меток, применяемых к целевой конфигурации. Рекомендуется использовать метки --custom-, а не --labels. Пример формата: {"key0":"value0", "key1":"value1"}.

--login -l

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

--metrics -m

Определения метрик конфигурации устройства. Укажите путь к файлу или необработанный json. Рекомендуется использовать запросы --custom-metric-queries вместо --metrics.

--pri --priority

Вес конфигурации устройства в случае конкурирующих правил (самые высокие выигрыши).

значение по умолчанию: 0

--resource-group -g

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

--target-condition --tc -t

Целевое условие, к которому применяется конфигурация устройства или модуля. Конфигурации без целевого условия не предназначены для устройства или модуля. Используйте следующий формат: "tags.environment='test".

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

--debug

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

--help -h

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

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az iot hub configuration delete

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

az iot hub configuration delete --config-id
                                [--auth-type {key, login}]
                                [--etag]
                                [--hub-name]
                                [--login]
                                [--resource-group]

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

--config-id -c

Имя конфигурации целевого устройства. Строчные регистры и следующие специальные символы разрешены: [-+%_*!].

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

--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 не указан.

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

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az iot hub configuration list

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

az iot hub configuration list [--auth-type {key, login}]
                              [--hub-name]
                              [--login]
                              [--resource-group]
                              [--top]

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

--auth-type

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

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

значение по умолчанию: key

--hub-name -n

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

--login -l

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

--resource-group -g

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

--top

Максимальное количество возвращаемых конфигураций. По умолчанию возвращаются все конфигурации.

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

--debug

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

--help -h

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

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az iot hub configuration show

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

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

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

--config-id -c

Имя конфигурации целевого устройства. Строчные регистры и следующие специальные символы разрешены: [-+%_*!].

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

--auth-type

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

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

значение по умолчанию: key

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

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az iot hub configuration show-metric

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

az iot hub configuration show-metric --config-id
                                     --metric-id
                                     [--auth-type {key, login}]
                                     [--hub-name]
                                     [--login]
                                     [--metric-type {system, user}]
                                     [--resource-group]

Примеры

Оценка определяемой пользователем метрики warningLimit

az iot hub configuration show-metric -m warningLimit -c {configuration_name} -n {iothub_name}

Оценка метрики "appliedCount" системы

az iot hub configuration show-metric --metric-id appliedCount -c {configuration_name} -n {iothub_name} --metric-type system

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

--config-id -c

Имя конфигурации целевого устройства. Строчные регистры и следующие специальные символы разрешены: [-+%_*!].

--metric-id -m

Целевая метрика для оценки.

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

--auth-type

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

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

значение по умолчанию: key

--hub-name -n

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

--login -l

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

--metric-type --mt

Указывает, какая коллекция метрик должна использоваться для поиска метрик.

допустимые значения: system, user

значение по умолчанию: user

--resource-group -g

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

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

--debug

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

--help -h

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

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az iot hub configuration update

Обновите указанные свойства конфигурации автоматического управления устройствами Интернета вещей.

Используйте --set, за которым следует назначения свойств для обновления конфигурации.

Примечание. Содержимое конфигурации неизменяемо. Свойства конфигурации, которые можно обновить, — метки, метрики, приоритет и targetCondition.

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

Примеры

Изменение приоритета конфигурации устройства и обновление целевого условия

az iot hub configuration update -c {configuration_name} -n {iothub_name} --set priority=10 targetCondition="tags.building=43 and tags.environment='dev'"

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

--config-id -c

Имя конфигурации целевого устройства. Строчные регистры и следующие специальные символы разрешены: [-+%_*!].

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

--add

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

значение по умолчанию: []

--auth-type

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

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

значение по умолчанию: key

--etag -e

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

--force-string

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

значение по умолчанию: False

--hub-name -n

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

--login -l

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

--remove

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

значение по умолчанию: []

--resource-group -g

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

--set

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

значение по умолчанию: []

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

--debug

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

--help -h

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

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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