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

az cloudhsm

Note

此参考是 Azure CLI（版本 2.70.0 或更高版本）的 cloudhsm 扩展的一部分。该扩展将在首次运行 az cloudhsm 命令时自动安装。了解更多关于扩展的信息。

管理云 Hsm 群集。

命令

名称	说明	类型	Status
az cloudhsm backup	管理云 HSM 备份。	Extension	GA
az cloudhsm backup start	开始备份云 HSM。	Extension	GA
az cloudhsm create	创建云 HSM。	Extension	GA
az cloudhsm delete	删除云 HSM。	Extension	GA
az cloudhsm list	列出云 HSM。	Extension	GA
az cloudhsm restore	还原云 HSM 的备份。	Extension	GA
az cloudhsm restore start	还原云 HSM 的备份。	Extension	GA
az cloudhsm show	显示云 HSM 的详细信息。	Extension	GA
az cloudhsm update	更新云 HSM 的属性。	Extension	GA

az cloudhsm create

创建云 HSM。

az cloudhsm create --name
                   --resource-group
                   [--domain-label-scope --domain-name-label-scope {NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse}]
                   [--location]
                   [--mi-user-assigned]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--sku {Standard B10, Standard_B1}]
                   [--tags]

示例

使用用户分配的托管标识创建云 HSM

az cloudhsm create --resource-group rgcloudhsm --name chsm1 --location eastus2 --sku Standard_B1 --tags Department=Accounting --domain-name-label-scope "TenantReuse" --mi-user-assigned /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm /providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity

必需参数

--name -n

指定资源组中的云 HSM 群集的名称。云 HSM 群集名称长度必须介于 3 到 23 个字符之间。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--domain-label-scope --domain-name-label-scope

云 HSM 群集自动生成的域名标签范围。

属性	值
参数组:	Properties Arguments
接受的值:	NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse

--location -l

未指定资源所在的地理位置，将使用资源组的位置。

属性	值
参数组:	Body Arguments

--mi-user-assigned

设置用户托管标识。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
参数组:	Identity Arguments

--no-wait

不等待长时间运行的操作完成。

属性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--sku

云 HSM 群集的 SKU 名称。

属性	值
参数组:	Sku Arguments
默认值:	Standard_B1
接受的值:	Standard B10, Standard_B1

--tags

资源标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
参数组:	Body Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

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

--verbose

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

属性	值
默认值:	False

az cloudhsm delete

删除云 HSM。

az cloudhsm delete [--ids]
                   [--name]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--resource-group]
                   [--subscription]
                   [--yes]

示例

删除云 HSM

az cloudhsm delete --resource-group rgcloudhsm --name chsm1

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
参数组:	Resource Id Arguments

--name -n

指定资源组中的云 HSM 群集的名称。云 HSM 群集名称长度必须介于 3 到 23 个字符之间。

属性	值
参数组:	Resource Id Arguments

--no-wait

不等待长时间运行的操作完成。

属性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

属性	值
参数组:	Resource Id Arguments

--subscription

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

属性	值
参数组:	Resource Id Arguments

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

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

属性	值
默认值:	False

az cloudhsm list

列出云 HSM。

az cloudhsm list [--max-items]
                 [--next-token]
                 [--resource-group]

示例

显示所选订阅中的所有云 HSM

az cloudhsm list
az cloudhsm list --subscription subId

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

属性	值
参数组:	Pagination Arguments

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

属性	值
参数组:	Pagination Arguments

--resource-group -g

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

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

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

--verbose

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

属性	值
默认值:	False

az cloudhsm show

显示云 HSM 的详细信息。

az cloudhsm show [--ids]
                 [--name]
                 [--resource-group]
                 [--subscription]

示例

显示云 HSM 的详细信息。

az cloudhsm show --resource-group rgcloudhsm --name chsm1

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
参数组:	Resource Id Arguments

--name -n

指定资源组中的云 HSM 群集的名称。云 HSM 群集名称长度必须介于 3 到 23 个字符之间。

属性	值
参数组:	Resource Id Arguments

--resource-group -g

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

属性	值
参数组:	Resource Id Arguments

--subscription

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

属性	值
参数组:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

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

属性	值
默认值:	False

az cloudhsm update

更新云 HSM 的属性。

az cloudhsm update [--ids]
                   [--mi-user-assigned]
                   [--name]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--resource-group]
                   [--subscription]
                   [--tags]

示例

更新云 HSM 的属性

az cloudhsm update --name chsm1 --resource-group myrg --tags Department=Accounting

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
参数组:	Resource Id Arguments

--mi-user-assigned

设置用户托管标识。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
参数组:	Identity Arguments

--name -n

指定资源组中的云 HSM 群集的名称。云 HSM 群集名称长度必须介于 3 到 23 个字符之间。

属性	值
参数组:	Resource Id Arguments

--no-wait

不等待长时间运行的操作完成。

属性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

属性	值
参数组:	Resource Id Arguments

--subscription

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

属性	值
参数组:	Resource Id Arguments

--tags

云 HSM 群集的标记支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
参数组:	Body Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

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

属性	值
默认值:	False

反馈

此页面是否有帮助？

通过

az cloudhsm

命令

az cloudhsm create

示例

必需参数

可选参数

az cloudhsm delete

示例

可选参数

az cloudhsm list

示例

可选参数

az cloudhsm show

示例

可选参数

az cloudhsm update

示例

可选参数

反馈