az iot edge devices

Примечание.

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

Команды для управления устройствами IoT Edge.

Команды

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

Создание и настройка нескольких пограничных устройств в Центр Интернета вещей.

Расширение Экспериментальный

az iot edge devices create

Экспериментальный

Эта команда является экспериментальной и в стадии разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

Создание и настройка нескольких пограничных устройств в Центр Интернета вещей.

Эта операция принимает встроенные аргументы устройства или файл конфигурации пограничных устройств в формате YAML или JSON. Встроенные команды args (например,-device-device-auth) будут иметь приоритет и переопределить свойства файла конфигурации, если они указаны. Пример файла конфигурации можно найти здесь: https://aka.ms/aziotcli-edge-devices-config ознакомьтесь с примерами и описаниями параметров для получения подробных сведений о том, как полностью использовать эту операцию.

az iot edge devices create [--auth-type {key, login}]
                           [--cfg]
                           [--clean {false, true}]
                           [--dct]
                           [--dea]
                           [--device]
                           [--device-auth {shared_private_key, x509_thumbprint}]
                           [--hub-name]
                           [--login]
                           [--out]
                           [--rc]
                           [--resource-group]
                           [--rk]
                           [--root-pass]
                           [--vis {false, true}]
                           [--yes {false, true}]

Примеры

Создание нескольких пограничных устройств с помощью проверки подлинности симметричного ключа (по умолчанию)

az iot edge devices create -n {hub_name} --device id=device_1 --device id=device_2

Создайте плоский список пограничных устройств с помощью самозаверяющей проверки подлинности сертификата с различными конфигурациями свойств edge, используя встроенные аргументы.

az iot edge devices create -n {hub_name} --device-auth x509_thumbprint --default-edge-agent "mcr.microsoft.com/azureiotedge-agent:1.4"
--device id=device_1 hostname={FQDN}
--device id=device_2 edge_agent={agent_image}
--device id=parent hostname={FQDN} edge_agent={agent_image} container_auth={path_or_json_string}

Удалите все существующие удостоверения устройств в концентраторе и создайте новые устройства на основе файла конфигурации (с индикаторами выполнения и выходными данными визуализации).

az iot edge devices create -n {hub_name} --cfg path/to/config_yml_or_json -c -v

Создайте группу вложенных пограничных устройств с настраиваемыми развертываниями модулей, содержащей 2 родительских устройства с 1 дочерним устройством, используя встроенные аргументы. Также указывает выходной путь для пакетов сертификатов устройств.

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--device id=parent_1 deployment=/path/to/parentDeployment_1.json
--device id=child_1 parent=parent_1 deployment=/path/to/child_deployment_1.json
--device id=parent_2 deployment=/path/to/parentDeployment_2.json
--device id=child_2 parent=parent_2 deployment=/path/to/child_deployment_2.json

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

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--root-cert "root_cert.pem" --root-key "root_key.pem" --device-auth x509_thumbprint
--device id=parent1
--device id=child1 parent=parent1

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

--auth-type

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

допустимые значения: key, login
значение по умолчанию: key
--cfg --config --config-file

Путь к файлу конфигурации устройств. Пример файла конфигурации: https://aka.ms/aziotcli-edge-devices-config.

--clean -c

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

допустимые значения: false, true
значение по умолчанию: False
--dct --device-config-template

Путь к файлу config.toml IoT Edge для использования в качестве основы для конфигураций пограничных устройств.

--dea --default-agent --default-edge-agent

Агент пограничных вычислений по умолчанию для созданных пограничных устройств, если он не указан по отдельности.

--device -d

Пары key=value, разделенные пробелами, соответствующие свойствам создаваемого пограничного устройства. Поддерживаются следующие ключевые значения: id (device_id), deployment (встроенный json или путь к файлу), hostnameparent (device_id), edge_agent (URL-адрес изображения) и container_auth (встроенный json или путь к файлу). --device можно использовать 1 или более раз. Ознакомьтесь с примерами справки по полному использованию параметров. Эти параметры также ссылаются на соответствующие значения в нашем примере файла конфигурации: https://aka.ms/aziotcli-edge-devices-config

--device-auth --device-auth-type

Механизм авторизации устройства для концентратора.

допустимые значения: shared_private_key, x509_thumbprint
--hub-name -n

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

--login -l

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

--out --output-path

Путь к пакетам конфигурации выходного устройства. Если это значение не указано, выходные данные файла не будут созданы.

--rc --root-cert

Путь к сертификату корневого открытого ключа для подписывания вложенных сертификатов пограничного устройства.

--resource-group -g

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

--rk --root-key

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

--root-pass --rp

Пароль корневого ключа.

--vis --visualize -v

Отображает визуализации устройств и ход выполнения различных задач (создание устройства, настройка родителей, обновление конфигураций и т. д.).

допустимые значения: false, true
значение по умолчанию: False
--yes -y

Не запрашивайте подтверждение, если параметр --clean используется для удаления существующих центральных устройств.

допустимые значения: false, true
значение по умолчанию: False
Глобальные параметры
--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.