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

az iot device registration

  • 预览
  • 参考

注意

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

此命令组处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

管理 IoT 设备预配服务的 IoT 设备注册。

使用 az iot dps enrollment registration 或删除 az iot dps enrollment-group registration 注册。

命令

名称 说明 类型 状态
az iot device registration create

将 IoT 设备注册到 IoT 设备预配服务。

 扩展 预览

az iot device registration create

预览

命令组“iot 设备注册”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

将 IoT 设备注册到 IoT 设备预配服务。

支持以下证明机制：

  • 对称密钥
  • x509 证书如果使用 x509 身份验证方法，则必须提供证书和密钥文件（如果需要）和通行短语。
az iot device registration create --registration-id
                                  [--auth-type {key, login}]
                                  [--certificate-file-path]
                                  [--ck]
                                  [--dps-name]
                                  [--enrollment-group-id]
                                  [--host]
                                  [--id-scope]
                                  [--key]
                                  [--key-file-path]
                                  [--login]
                                  [--pass]
                                  [--payload]
                                  [--resource-group]

示例

使用单个注册注册 IoT 设备。

az iot device registration create -n {dps_name} --rid {registration_id}

使用组注册注册 IoT 设备。

az iot device registration create -n {dps_name} --rid {registration_id} --gid {group_enrollment_id}

使用单个注册、设备预配服务 ID 范围和给定的对称密钥注册 IoT 设备。 这将绕过检索 ID 范围和二维注册对称密钥。

az iot device registration create --id-scope {id_scope} --rid {registration_id} --key {symmetric_key}

使用组注册、设备预配服务 ID 范围和给定的注册组对称密钥注册 IoT 设备。 这将绕过检索 ID 范围和注册组对称密钥。 用于设备注册的对称密钥将从给定的对称密钥中计算。

az iot device registration create --id-scope {id_scope} --rid {registration_id} --gid {group_enrollment_id} --key {symmetric_key} --ck

使用组注册、设备预配服务 ID 范围和给定的对称密钥注册 IoT 设备。 这将绕过检索 ID 范围。 请注意，由于对称密钥应为计算设备密钥，因此不需要注册组 ID。

az iot device registration create --id-scope {id_scope} --rid {registration_id} --key {symmetric_key}

使用单个注册、设备预配服务 ID 范围以及给定的证书和密钥文件注册 IoT 设备。 这将绕过检索 ID 范围。

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file}

使用单个注册、设备预配服务 ID 范围以及密钥文件的给定证书和密钥文件和通行短语注册 IoT 设备。 这将绕过检索 ID 范围。

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file} --pass {passphrase}

使用组注册、设备预配服务 ID 范围以及给定的证书和密钥文件注册 IoT 设备。 这将绕过检索 ID 范围。 请注意，x509 证明不需要组注册 ID，证书文件的主题是注册 ID。

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file}

必需参数

--registration-id --rid

设备注册 ID 或单个注册 ID。

可选参数

--auth-type

指示操作是应自动派生策略密钥还是使用当前的 Azure AD 会话。 如果身份验证类型为登录，并且提供资源主机名，则除非需要，否则将跳过资源查找。可以使用 < a0/a0> 配置默认值 az configure --defaults iothub-data-auth-type=<auth-type-value>。

接受的值: key, login
默认值: key
--certificate-file-path --cp

证书 PEM 文件的路径。 x509 注册所必需的。

--ck --compute-key

用于指示应使用 --symmetric-key 从给定密钥计算设备注册的对称密钥的标志。

默认值: False
--dps-name -n

Azure IoT 中心设备预配服务的名称。 如果未提供 --login 或 authenticaton 参数且未提供 --id-scope，则是必需的。

--enrollment-group-id --gid --group-id

注册组 ID。 仅需要检索身份验证参数。

--host --provisioning-host

指向要使用的预配主机的终结点。

默认值: global.azure-devices-provisioning.net
--id-scope --scope

Azure IoT 中心设备预配服务的 ID 范围。 如果提供身份验证参数，将避免会话登录。

--key --symmetric-key

用于设备注册的对称共享访问密钥。

--key-file-path --kp

密钥 PEM 文件的路径。 x509 注册所必需的。

--login -l

此命令支持具有执行操作权限的实体连接字符串。 用于避免通过“az login”进行会话登录。 如果同时提供实体连接字符串和名称，则连接字符串优先。 如果未提供 --dps-name 或 authenticaton 参数，并且未提供 --id-scope，则是必需的。

--pass --passphrase

证书的通行短语。

--payload

自定义分配有效负载作为 JSON。 具体而言，用于使用 Azure Functions 的自定义分配策略。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数
--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 获取完整的调试日志。