az iot hub configuration

Note

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

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

Команды

Имя Описание Тип Состояние
az iot hub configuration create

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

 Extension GA
az iot hub configuration delete

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

 Extension GA
az iot hub configuration list

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

 Extension GA
az iot hub configuration show

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

 Extension GA
az iot hub configuration show-metric

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

 Extension GA
az iot hub configuration update

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

 Extension GA

az iot hub configuration create

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

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

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

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

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

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

az iot hub configuration create --config-id
                                --content
                                [--acquire-policy-token]
                                [--auth-type {key, login}]
                                [--change-reference]
                                [--cl --custom-labels]
                                [--cmq --custom-metric-queries]
                                [--hub-name]
                                [--lab --labels]
                                [--login]
                                [--metrics]
                                [--pri --priority]
                                [--resource-group]
                                [--target-condition --tc]

Примеры

Создайте конфигурацию устройства с приоритетом 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.

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

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

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

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

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

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

--login -l

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

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

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

--pri --priority

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

Свойство Значение
Default value: 0
--resource-group -g

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

--target-condition --tc -t

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

Глобальные параметры
--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 configuration delete

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

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

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

--config-id -c

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

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

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

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

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

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

Свойство Значение
Группа параметров: 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>.

--top

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

Глобальные параметры
--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 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}.

Свойство Значение
Группа параметров: 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 configuration show-metric

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

az iot hub configuration show-metric --config-id
                                     --metric-id
                                     [--acquire-policy-token]
                                     [--auth-type {key, login}]
                                     [--change-reference]
                                     [--hub-name]
                                     [--login]
                                     [--metric-type --mt {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

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

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

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

--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
--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
--metric-type --mt

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

Свойство Значение
Default value: user
Допустимые значения: system, user
--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 configuration update

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

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

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

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

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

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

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

--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
--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: []
Глобальные параметры
--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