你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az iot edge devices

注意

此参考是 Azure CLI(版本 2.46.0 或更高版本)的 azure-iot 扩展的一部分。 该扩展将在首次运行 az iot edge devices 命令时自动安装。 详细了解扩展。

用于管理 IoT Edge 设备的命令。

命令

名称 说明 类型 Status
az iot edge devices create

在IoT 中心中创建和配置多个边缘设备。

扩展 实验

az iot edge devices create

实验

此命令是实验性的,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

在IoT 中心中创建和配置多个边缘设备。

此操作接受 YAML 或 JSON 格式的内联设备参数或边缘设备配置文件。 内联命令参数(如“--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

使用内联参数通过各种边缘属性配置使用自签名证书身份验证创建边缘设备的平面列表。

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

使用内联参数创建一组具有自定义模块部署的嵌套边缘设备-每个设备包含 1 个子设备的 2 个父设备。 此外,指定设备证书捆绑包的输出路径。

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 身份验证创建具有现有根 CA 的简单嵌套边缘设备配置,并指定自定义设备捆绑包输出路径。

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 会话。 如果身份验证类型为登录,并且提供资源主机名,则除非需要,否则将跳过资源查找。可以使用 < a0/a0> 配置默认值 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

要用作边缘设备配置基础的 IoT Edge config.toml 文件的路径。

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

如果未单独指定,则为创建的 Edge 设备的默认边缘代理。

--device -d

与要创建的边缘设备的属性对应的空格分隔键=值对。 支持以下键值: 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

IoT 中心名称或主机名。 如果未提供 --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

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。