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

az iot dps enrollment-group

  • 参考

注意

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

管理Azure IoT 中心设备预配服务中的注册组。

命令

名称 说明 类型 状态
az iot dps enrollment-group compute-device-key

为Azure IoT 中心设备预配服务中的注册组生成派生的设备 SAS 密钥。

 分机 GA
az iot dps enrollment-group create

在Azure IoT 中心设备预配服务中创建注册组。

 分机 GA
az iot dps enrollment-group delete

删除Azure IoT 中心设备预配服务中的注册组。

 扩展 GA
az iot dps enrollment-group list

列出Azure IoT 中心设备预配服务中的注册组。

 分机 GA
az iot dps enrollment-group registration

在Azure IoT 中心设备预配服务中管理注册组的服务端设备注册。

 分机 GA
az iot dps enrollment-group registration delete

删除Azure IoT 中心设备预配服务中注册组的设备注册。

 分机 GA
az iot dps enrollment-group registration list

列出Azure IoT 中心设备预配服务中注册组的设备注册。

 分机 GA
az iot dps enrollment-group registration show

获取Azure IoT 中心设备预配服务中注册组的设备注册。

 扩展 GA
az iot dps enrollment-group show

在Azure IoT 中心设备预配服务中获取注册组的详细信息。

 扩展 GA
az iot dps enrollment-group update

更新Azure IoT 中心设备预配服务中的注册组。

 分机 GA

az iot dps enrollment-group compute-device-key

为Azure IoT 中心设备预配服务中的注册组生成派生的设备 SAS 密钥。

az iot dps enrollment-group compute-device-key --registration-id
                                               [--auth-type {key, login}]
                                               [--dps-name]
                                               [--eid]
                                               [--key]
                                               [--login]
                                               [--resource-group]

示例

使用给定的对称密钥计算设备密钥。

az iot dps enrollment-group compute-device-key --key {enrollement_group_symmetric_key} --registration-id {registration_id}

使用给定的注册组计算设备密钥。

az iot dps enrollment-group compute-device-key -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --registration-id {registration_id}

必需参数

--registration-id --rid

设备注册的 ID。

可选参数

--auth-type

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

接受的值: key, login
默认值: key
--dps-name -n

Azure IoT 中心设备预配服务的名称或主机名。 如果未提供 --login，则为必需。

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

注册组 ID。

--key --symmetric-key

注册组的对称共享访问密钥。 这会绕过设备预配服务注册表，并直接从提供的对称密钥生成 SAS 令牌，而无需进一步验证。 除了注册 ID 之外，所有其他命令参数将被忽略。

--login -l

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

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

az iot dps enrollment-group create

在Azure IoT 中心设备预配服务中创建注册组。

请使用 Base64 ASCII 编码提供证书格式，证书应具有匹配的 BEGIN 和 END 段，例如：以“-----BEGIN CERTIFICATE-----”开头，以“-----END CERTIFICATE-----”结尾。

az iot dps enrollment-group create --eid
                                   [--allocation-policy {custom, geoLatency, hashed, static}]
                                   [--api-version]
                                   [--auth-type {key, login}]
                                   [--ca-name]
                                   [--certificate-path]
                                   [--dps-name]
                                   [--edge-enabled {false, true}]
                                   [--ih]
                                   [--initial-twin-properties]
                                   [--initial-twin-tags]
                                   [--login]
                                   [--pk]
                                   [--provisioning-status {disabled, enabled}]
                                   [--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
                                   [--resource-group]
                                   [--scn]
                                   [--scp]
                                   [--secondary-key]
                                   [--webhook-url]

示例

使用中间证书作为主证书在资源组“{resource_group_name}”的 Azure IoT 预配服务“{dps_name}”中创建注册组“{enrollment_id}”。

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem

使用 CA 证书 {certificate_name} 作为辅助证书，在资源组“{resource_group_name}”的 Azure IoT 预配服务“{dps_name}”中创建注册组“{enrollment_id}”。

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name}

使用中间证书作为主证书，在资源组“{resource_group_name}”的 Azure IoT 预配服务“MyDps”中创建注册组“{enrollment_id}”。初始孪生属性“{”location“：{”region“：”US“}}”和初始孪生标记“{”version_dps“：”1“}”。

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem --provisioning-status enabled --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version_dps':'1'}"

在资源组“{enrollment_id resource_group_name}”中的 Azure IoT 预配服务“{dps_name}”中创建注册组“{resource_group_name}”，并证明类型为“symmetrickey”。

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {primary_key} --secondary-key {secondary_key}

使用自定义分配策略创建注册组“{enrollment_id}”

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}

必需参数

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

注册组 ID。

可选参数

--allocation-policy --ap

分配策略的类型，用于确定如何将设备分配到IoT 中心。 如果未提供，则分配策略将是设备预配服务实例的当前分配策略默认设置。

接受的值: custom, geoLatency, hashed, static
--api-version --av

自定义分配请求中发送的预配服务类型的 API 版本。 支持的最低版本：2018-09-01-preview。

--auth-type

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

接受的值: key, login
默认值: key
--ca-name --cn --root-ca-name

主根 CA 证书的名称。 如果需要使用根 CA 证书进行证明，则必须提供根 CA 名称。

--certificate-path --cp

包含主证书的文件的路径。 如果需要使用中间证书进行证明，则必须提供证书路径。

--dps-name -n

Azure IoT 中心设备预配服务的名称或主机名。 如果未提供 --login，则为必需。

--edge-enabled --ee

指示边缘启用的标志。

接受的值: false, true
默认值: False
--ih --iot-hubs

与分配策略关联的目标IoT 中心的主机名。 对多个IoT 中心使用空格分隔的列表。

--initial-twin-properties --props

初始设备孪生属性。

--initial-twin-tags --tags

初始设备孪生标记。

--login -l

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

--pk --primary-key

以 base64 格式存储的主对称共享访问密钥。

--provisioning-status --ps

启用或禁用注册条目。

接受的值: disabled, enabled
--reprovision-policy --rp

用于确定在重新预配到其他IoT 中心时应如何处理设备数据的策略。

接受的值: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

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

--scn --secondary-ca-name --secondary-root-ca-name

辅助根 CA 证书的名称。 如果需要使用根 CA 证书进行证明，则必须提供根 CA 名称。

--scp --secondary-certificate-path

包含辅助证书的文件的路径。 如果需要使用中间证书进行证明，则必须提供证书路径。

--secondary-key --sk

以 base64 格式存储的辅助对称共享访问密钥。

--webhook-url --wh

用于自定义分配请求的 Azure Function Webhook URL。

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

az iot dps enrollment-group delete

删除Azure IoT 中心设备预配服务中的注册组。

az iot dps enrollment-group delete --eid
                                   [--auth-type {key, login}]
                                   [--dps-name]
                                   [--etag]
                                   [--login]
                                   [--resource-group]

必需参数

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

注册组 ID。

可选参数

--auth-type

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

接受的值: key, login
默认值: key
--dps-name -n

Azure IoT 中心设备预配服务的名称或主机名。 如果未提供 --login，则为必需。

--etag -e

对应于资源最后状态的 Etag 或实体标记。 如果未提供 etag，则使用值“*”。

--login -l

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

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

az iot dps enrollment-group list

列出Azure IoT 中心设备预配服务中的注册组。

az iot dps enrollment-group list [--auth-type {key, login}]
                                 [--dps-name]
                                 [--login]
                                 [--resource-group]
                                 [--top]

可选参数

--auth-type

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

接受的值: key, login
默认值: key
--dps-name -n

Azure IoT 中心设备预配服务的名称或主机名。 如果未提供 --login，则为必需。

--login -l

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

--resource-group -g

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

--top

要返回的最大元素数。 使用 -1 无限制。

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

az iot dps enrollment-group show

在Azure IoT 中心设备预配服务中获取注册组的详细信息。

az iot dps enrollment-group show --eid
                                 [--auth-type {key, login}]
                                 [--dps-name]
                                 [--keys {false, true}]
                                 [--login]
                                 [--resource-group]

示例

基本用法

az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}

在对称密钥注册组的结果中包含完整的证明信息

az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys

必需参数

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

注册组 ID。

可选参数

--auth-type

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

接受的值: key, login
默认值: key
--dps-name -n

Azure IoT 中心设备预配服务的名称或主机名。 如果未提供 --login，则为必需。

--keys --show-keys

在注册组结果中包含证明密钥和信息。

接受的值: false, true
--login -l

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

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

az iot dps enrollment-group update

更新Azure IoT 中心设备预配服务中的注册组。

请使用 Base64 ASCII 编码提供证书格式，证书应具有匹配的 BEGIN 和 END 段，例如：以“-----BEGIN CERTIFICATE-----”开头，以“-----END CERTIFICATE-----”结尾。

az iot dps enrollment-group update --eid
                                   [--allocation-policy {custom, geoLatency, hashed, static}]
                                   [--api-version]
                                   [--auth-type {key, login}]
                                   [--ca-name]
                                   [--certificate-path]
                                   [--dps-name]
                                   [--edge-enabled {false, true}]
                                   [--etag]
                                   [--ih]
                                   [--initial-twin-properties]
                                   [--initial-twin-tags]
                                   [--login]
                                   [--pk]
                                   [--provisioning-status {disabled, enabled}]
                                   [--rc {false, true}]
                                   [--remove-secondary-certificate {false, true}]
                                   [--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
                                   [--resource-group]
                                   [--scn]
                                   [--scp]
                                   [--secondary-key]
                                   [--webhook-url]

示例

使用初始孪生属性和初始孪生标记更新资源组“{resource_group_name}”中的 Azure IoT 预配服务“{dps_name}”中的注册组“{enrollment_id}”。

az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version_dps':'2'}" --etag AAAAAAAAAAA=

使用新的主中间证书更新资源组“{enrollment_id}”中的 Azure IoT 预配服务“{dps_name}”中的注册组“{resource_group_name}”，并删除现有的辅助中间证书。

az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --remove-secondary-certificate --etag AAAAAAAAAAA=

使用新的辅助 CA 证书“{enrollment_id certificate_name}”更新资源组“{resource_group_name}”中的 Azure IoT 预配服务“{dps_name}”中的注册组“{certificate_name}”，并删除现有的主 CA 证书。

az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name} --remove-certificate --etag AAAAAAAAAAA=

使用新的主键更新资源组“{resource_group_name}”中的 Azure IoT 预配服务“{dps_name}”中的注册组“{enrollment_id}”。

az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=

必需参数

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

注册组 ID。

可选参数

--allocation-policy --ap

分配策略的类型，用于确定如何将设备分配到IoT 中心。 如果未提供，则分配策略将是设备预配服务实例的当前分配策略默认设置。

接受的值: custom, geoLatency, hashed, static
--api-version --av

自定义分配请求中发送的预配服务类型的 API 版本。 支持的最低版本：2018-09-01-preview。

--auth-type

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

接受的值: key, login
默认值: key
--ca-name --cn --root-ca-name

主根 CA 证书的名称。 如果需要使用根 CA 证书进行证明，则必须提供根 CA 名称。

--certificate-path --cp

包含主证书的文件的路径。 如果需要使用中间证书进行证明，则必须提供证书路径。

--dps-name -n

Azure IoT 中心设备预配服务的名称或主机名。 如果未提供 --login，则为必需。

--edge-enabled --ee

指示边缘启用的标志。

接受的值: false, true
--etag -e

对应于资源最后状态的 Etag 或实体标记。 如果未提供 etag，则使用值“*”。

--ih --iot-hubs

与分配策略关联的目标IoT 中心的主机名。 对多个IoT 中心使用空格分隔的列表。

--initial-twin-properties --props

初始设备孪生属性。

--initial-twin-tags --tags

初始设备孪生标记。

--login -l

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

--pk --primary-key

以 base64 格式存储的主对称共享访问密钥。

--provisioning-status --ps

启用或禁用注册条目。

接受的值: disabled, enabled
--rc --remove-certificate

用于删除当前主证书的标志。

接受的值: false, true
--remove-secondary-certificate --rsc

用于删除当前辅助证书的标志。

接受的值: false, true
--reprovision-policy --rp

用于确定在重新预配到其他IoT 中心时应如何处理设备数据的策略。

接受的值: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

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

--scn --secondary-ca-name --secondary-root-ca-name

辅助根 CA 证书的名称。 如果需要使用根 CA 证书进行证明，则必须提供根 CA 名称。

--scp --secondary-certificate-path

包含辅助证书的文件的路径。 如果需要使用中间证书进行证明，则必须提供证书路径。

--secondary-key --sk

以 base64 格式存储的辅助对称共享访问密钥。

--webhook-url --wh

用于自定义分配请求的 Azure Function Webhook URL。

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