az iot edge

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). Расширение автоматически установит первый раз, когда вы запускаете команду az iot edge. Learn more about extensions.

Управление решениями Интернета вещей в пограничной среде.

Команды

Имя	Описание	Тип	Состояние
az iot edge deployment	Управление развертываниями IoT Edge в большом масштабе.	Extension	GA
az iot edge deployment create	Создайте развертывание IoT Edge в целевом Центр Интернета вещей.	Extension	GA
az iot edge deployment delete	Удаление развертывания IoT Edge.	Extension	GA
az iot edge deployment list	Вывод списка развертываний IoT Edge в Центр Интернета вещей.	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	Создание и настройка нескольких пограничных устройств в Центр Интернета вещей.	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
                           [--auth-type {key, login}]
                           [--hub-name]
                           [--login]
                           [--resource-group]

Примеры

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

az iot edge export-modules --hub-name {iothub_name} --device-id {device_id}

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

--device-id -d

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

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

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

--hub-name -n

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

Свойство	Значение
Parameter group:	IoT Hub Identifier Arguments

--login -l

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

Свойство	Значение
Parameter group:	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

Output format.

Свойство	Значение
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 edge set-modules

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

Содержимое модулей — json и в виде {"modulesContent":{...}} or {"content":{"modulesContent":{...}}}.

По умолчанию свойства системных модулей $edgeAgent и $edgeHub проверяются на соответствие схемам, установленным с расширением IoT. Это можно отключить с помощью переключателя --no-validation.

Примечание. После выполнения команда выводит коллекцию модулей, примененных к устройству.

az iot edge set-modules --content
                        --device-id
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--resource-group]

Примеры

Тестирование пограничных модулей во время разработки путем установки модулей на целевом устройстве.

az iot edge set-modules --hub-name {iothub_name} --device-id {device_id} --content ../modules_content.json

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

--content -k

Содержимое развертывания IoT Edge. Укажите путь к файлу или необработанный json.

--device-id -d

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

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

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

--hub-name -n

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

Свойство	Значение
Parameter group:	IoT Hub Identifier Arguments

--login -l

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

Свойство	Значение
Parameter group:	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

Output format.

Свойство	Значение
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