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

az iot central enrollment-group

参考

注意

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

管理和配置 IoT Central 注册组。

命令

名称	说明	类型	Status
az iot central enrollment-group create	创建注册组。	扩展	GA
az iot central enrollment-group delete	按 ID 删除注册组。	扩展	GA
az iot central enrollment-group generate-verification-code	为注册组的主证书或辅助 x509 证书生成验证码。	扩展	GA
az iot central enrollment-group list	获取应用程序中的注册组列表。	扩展	GA
az iot central enrollment-group show	按 ID 获取有关注册组的详细信息。	扩展	GA
az iot central enrollment-group update	更新注册组。	扩展	GA
az iot central enrollment-group verify-certificate	验证注册组的主证书或辅助 x509 证书。	扩展	GA

az iot central enrollment-group create

创建注册组。

az iot central enrollment-group create --app-id
                                       --at {symmetricKey, x509}
                                       --display-name
                                       --group-id
                                       --type
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-path]
                                       [--etag]
                                       [--pk]
                                       [--provisioning-status {disabled, enabled}]
                                       [--scp]
                                       [--secondary-key]
                                       [--token]

示例

创建注册组

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at {attestation} --display-name {displayName} --type {type}

使用 x509 主要认证创建注册组

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'x509' --display-name {displayName} --type {type} --cp {primayCertPath}

创建具有给定对称密钥认证的注册组

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'symmetricKey' --display-name {displayName} --type {type} --pk {primaryKey} --sk {secondaryKey}

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。可以在应用程序“关于”页面的帮助菜单下找到应用 ID。

--at --attestation-type

注册组的证明机制。仅允许“x509”或“symmetricKey”。默认情况下，“symmetricKey”将用于证明。

接受的值: symmetricKey, x509

默认值: symmetricKey

--display-name

注册组的显示名称。

--group-id --id

注册组的唯一标识符。

--type

通过组连接的设备的类型。

可选参数

--api-version --av

已放弃

参数“api_version”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--certificate-path --cp

包含主证书的文件的路径。

--etag -e

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

--pk --primary-key

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

--provisioning-status --ps

是否允许使用组的设备连接到 IoT Central。判断正误。

接受的值: disabled, enabled

默认值: enabled

--scp --secondary-certificate-path

包含辅助证书的文件的路径。

--secondary-key --sk

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

--token

如果想要在不对 Azure CLI 进行身份验证的情况下提交请求，可以指定有效的用户令牌对请求进行身份验证。必须将密钥类型指定为请求的一部分。更多信息请访问 https://aka.ms/iotcentraldocsapi。

全局参数

--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 central enrollment-group delete

按 ID 删除注册组。

az iot central enrollment-group delete --app-id
                                       --group-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--token]

示例

按 ID 删除注册组

az iot central enrollment-group delete --app-id {appid} --id {enrollmentGroupId}

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。可以在应用程序“关于”页面的帮助菜单下找到应用 ID。

--group-id --id

注册组的唯一标识符。

可选参数

--api-version --av

已放弃

参数“api_version”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--token

全局参数

--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 central enrollment-group generate-verification-code

为注册组的主证书或辅助 x509 证书生成验证码。

az iot central enrollment-group generate-verification-code --app-id
                                                           --group-id
                                                           [--api-version {2022-06-30-preview, 2022-07-31}]
                                                           [--central-api-uri]
                                                           [--certificate-entry {primary, secondary}]
                                                           [--token]

示例

为注册组的主 x509 证书生成验证码

az iot central enrollment-group generate-verification-code --app-id {appid} --id {enrollmentGroupId} --entry 'primary'

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。可以在应用程序“关于”页面的帮助菜单下找到应用 ID。

--group-id --id

注册组的唯一标识符。

可选参数

--api-version --av

已放弃

参数“api_version”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--certificate-entry --entry

仅允许“primary”和“secondary”的 x509 证书的条目类型。

接受的值: primary, secondary

--token

全局参数

--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 central enrollment-group list

获取应用程序中的注册组列表。

az iot central enrollment-group list --app-id
                                     [--api-version {2022-06-30-preview, 2022-07-31}]
                                     [--central-api-uri]
                                     [--token]

示例

获取应用程序中的注册组列表

az iot central enrollment-group list --app-id {appid}

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。可以在应用程序“关于”页面的帮助菜单下找到应用 ID。

可选参数

--api-version --av

已放弃

参数“api_version”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--token

全局参数

--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 central enrollment-group show

按 ID 获取有关注册组的详细信息。

az iot central enrollment-group show --app-id
                                     --group-id
                                     [--api-version {2022-06-30-preview, 2022-07-31}]
                                     [--central-api-uri]
                                     [--certificate-entry {primary, secondary}]
                                     [--token]

示例

按 ID 获取有关注册组的详细信息

az iot central enrollment-group show --app-id {appid} --id {enrollmentGroupId}

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。可以在应用程序“关于”页面的帮助菜单下找到应用 ID。

--group-id --id

注册组的唯一标识符。

可选参数

--api-version --av

已放弃

参数“api_version”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--certificate-entry --entry

仅允许“primary”和“secondary”的 x509 证书的条目类型。

接受的值: primary, secondary

--token

全局参数

--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 central enrollment-group update

更新注册组。

az iot central enrollment-group update --app-id
                                       --group-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-entry {primary, secondary}]
                                       [--certificate-path]
                                       [--display-name]
                                       [--etag]
                                       [--provisioning-status {disabled, enabled}]
                                       [--remove-x509 {false, true}]
                                       [--scp]
                                       [--token]
                                       [--type]

示例

更新注册组

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --display-name {displayName} --type {type} --ps {enabled}

从注册组中删除 x509 主证书

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --remove-x509 'true' --entry 'primary'

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。可以在应用程序“关于”页面的帮助菜单下找到应用 ID。

--group-id --id

注册组的唯一标识符。

可选参数

--api-version --av

已放弃

参数“api_version”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--certificate-entry --entry

仅允许“primary”和“secondary”的 x509 证书的条目类型。

接受的值: primary, secondary

--certificate-path --cp

包含主证书的文件的路径。

--display-name

注册组的显示名称。

--etag

用于防止注册组更新冲突的 ETag。

--provisioning-status --ps

是否允许使用组的设备连接到 IoT Central。判断正误。

接受的值: disabled, enabled

默认值: enabled

--remove-x509

是否应从组中删除 x509 证书。判断正误。

接受的值: false, true

--scp --secondary-certificate-path

包含辅助证书的文件的路径。

--token

--type

通过组连接的设备的类型。

全局参数

--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 central enrollment-group verify-certificate

验证注册组的主证书或辅助 x509 证书。

通过提供带签名验证码的证书来验证注册组的主证书或辅助 x509 证书。

请注意，如果使用未验证的 x509 证书创建了注册组，则需要使用未经验证的 x509 证书和验证码创建验证证书，然后再使用此命令。可以使用“enrollment-group generate-verification-code”命令通过 cli 生成验证码。详细了解如何使用验证码在以下位置 https://learn.microsoft.com/en-us/azure/iot-central/core/how-to-connect-devices-x509创建验证证书。

az iot central enrollment-group verify-certificate --app-id
                                                   --group-id
                                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                                   [--central-api-uri]
                                                   [--certificate-path]
                                                   [--scp]
                                                   [--token]

示例

验证注册组的主 x509 证书

az iot central enrollment-group verify-certificate --app-id {appid} --id {enrollmentGroupId} --cp {primayCertPath}

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。可以在应用程序“关于”页面的帮助菜单下找到应用 ID。

--group-id --id

注册组的唯一标识符。

可选参数

--api-version --av

已放弃

参数“api_version”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--certificate-path --cp

包含主证书的文件的路径。

--scp --secondary-certificate-path

包含辅助证书的文件的路径。

--token

全局参数

--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 central enrollment-group

命令

az iot central enrollment-group create

示例

必需参数

可选参数

az iot central enrollment-group delete

示例

必需参数

可选参数

az iot central enrollment-group generate-verification-code

示例

必需参数

可选参数

az iot central enrollment-group list

示例

必需参数

可选参数

az iot central enrollment-group show

示例

必需参数

可选参数

az iot central enrollment-group update

示例

必需参数

可选参数

az iot central enrollment-group verify-certificate

示例

必需参数

可选参数

其他资源