az iot edge
Note
Эта ссылка является частью расширения Azure-iot для Azure CLI (версия 2.67.0 или более поздней). Расширение автоматически установит первый раз, когда вы запускаете команду az iot edge. Подробнее о расширениях.
Управление решениями Интернета вещей в пограничной среде.
Команды
| Имя | Описание | Тип | Состояние |
|---|---|---|---|
| az iot edge deployment |
Управление развертываниями IoT Edge в масштабе. |
Extension | GA |
| az iot edge deployment create |
Создайте развертывание IoT Edge в целевой IoT Hub. |
Extension | GA |
| az iot edge deployment delete |
Удаление развертывания IoT Edge. |
Extension | GA |
| az iot edge deployment list |
Вывод списка развертываний IoT Edge в IoT Hub. |
Extension | GA |
| az iot edge deployment show |
Получение сведений о развертывании IoT Edge. |
Extension | GA |
| az iot edge deployment show-metric |
Оцените целевую системную метрику, определенную в развертывании IoT Edge. |
Extension | GA |
| az iot edge deployment update |
Обновите указанные свойства развертывания IoT Edge. |
Extension | GA |
| az iot edge devices |
Команды для управления устройствами IoT Edge. |
Extension | GA |
| az iot edge devices create |
Создание и настройка нескольких пограничных устройств в IoT Hub. |
Extension | Experimental |
| az iot edge export-modules |
Экспорт конфигурации пограничных модулей на одном пограничном устройстве. |
Extension | GA |
| az iot edge set-modules |
Задайте пограничные модули на одном устройстве. |
Extension | GA |
az iot edge export-modules
Экспорт конфигурации пограничных модулей на одном пограничном устройстве.
Выходные данные конфигурации двойника модуля можно использовать непосредственно в качестве содержимого az iot edge set-modules.
az iot edge export-modules --device-id
[--acquire-policy-token]
[--auth-type {key, login}]
[--change-reference]
[--hub-name]
[--login]
[--resource-group]
Примеры
Экспорт конфигурации двойника модуля на целевом устройстве.
az iot edge export-modules --hub-name {iothub_name} --device-id {device_id}
Обязательные параметры
Идентификатор целевого устройства.
Необязательные параметры
Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.
Автоматическое получение маркера Azure Policy для этой операции ресурса.
| Свойство | Значение |
|---|---|
| Группа параметров: | Global Policy Arguments |
Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.
| Свойство | Значение |
|---|---|
| Группа параметров: | Access Control Arguments |
| Default value: | key |
| Допустимые значения: | key, login |
Связанный идентификатор ссылки на изменение для этой операции ресурса.
| Свойство | Значение |
|---|---|
| Группа параметров: | Global Policy Arguments |
IoT Hub имя или имя узла. Требуется, если --login не указан.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az iot edge set-modules
Задайте пограничные модули на одном устройстве.
Содержимое модулей — json и в виде {"modulesContent":{...}} или {"content":{"modulesContent":{...}}.
По умолчанию свойства системных модулей $edgeAgent и $edgeHub проверяются на соответствие схемам, установленным с расширением IoT. Это можно отключить с помощью переключателя --no-validation.
Примечание. После выполнения команда выводит коллекцию модулей, примененных к устройству.
az iot edge set-modules --content
--device-id
[--acquire-policy-token]
[--auth-type {key, login}]
[--change-reference]
[--hub-name]
[--login]
[--resource-group]
Примеры
Тестирование пограничных модулей во время разработки путем установки модулей на целевом устройстве.
az iot edge set-modules --hub-name {iothub_name} --device-id {device_id} --content ../modules_content.json
Обязательные параметры
IoT Edge содержимое развертывания. Укажите путь к файлу или необработанный json.
Идентификатор целевого устройства.
Необязательные параметры
Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.
Автоматическое получение маркера Azure Policy для этой операции ресурса.
| Свойство | Значение |
|---|---|
| Группа параметров: | Global Policy Arguments |
Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Можно настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type={auth-type-value}.
| Свойство | Значение |
|---|---|
| Группа параметров: | Access Control Arguments |
| Default value: | key |
| Допустимые значения: | key, login |
Связанный идентификатор ссылки на изменение для этой операции ресурса.
| Свойство | Значение |
|---|---|
| Группа параметров: | Global Policy Arguments |
IoT Hub имя или имя узла. Требуется, если --login не указан.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Эта команда поддерживает сущность connection string с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если connection string сущности и имя указаны, connection string имеет приоритет. Требуется, если имя --hub-name не указано.
| Свойство | Значение |
|---|---|
| Группа параметров: | IoT Hub Identifier Arguments |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |