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

az dedicated-hsm

参考

注意

此参考是 Azure CLI（版本 2.15.0 或更高版本）的硬件安全模块扩展的一部分。该扩展将在首次运行 az dedicated-hsm 命令时自动安装。详细了解扩展。

使用硬件安全模块管理专用 hsm。

命令

名称	说明	类型	状态
az dedicated-hsm create	在指定的订阅中创建专用 HSM。	分机	GA
az dedicated-hsm delete	删除指定的 Azure 专用 HSM。	分机	GA
az dedicated-hsm list	列表操作获取与订阅和指定资源组中关联的专用 hsms 的相关信息。 “列表”操作获取与订阅关联的专用 HSM 的相关信息。	扩展	GA
az dedicated-hsm list-outbound-network-dependency-endpoint	获取指定专用 hsm 资源中的出口终结点（所有出站依赖项的网络终结点）的列表。该操作返回每个出口终结点的属性。	分机	GA
az dedicated-hsm show	获取指定的 Azure 专用 HSM。	扩展	GA
az dedicated-hsm update	更新指定订阅中的专用 HSM。	分机	GA
az dedicated-hsm wait	将 CLI 置于等待状态，直到满足专用 hsm 的条件。	分机	GA

az dedicated-hsm create

在指定的订阅中创建专用 HSM。

az dedicated-hsm create --name
                        --resource-group
                        [--location]
                        [--mgmt-network-interfaces]
                        [--mgmt-network-subnet]
                        [--network-interfaces]
                        [--no-wait]
                        [--sku {SafeNet Luna Network HSM A790, payShield10K_LMK1_CPS250, payShield10K_LMK1_CPS2500, payShield10K_LMK1_CPS60, payShield10K_LMK2_CPS250, payShield10K_LMK2_CPS2500, payShield10K_LMK2_CPS60}]
                        [--stamp-id]
                        [--subnet]
                        [--tags]
                        [--zones]

示例

创建新的或更新现有的专用 HSM

az dedicated-hsm create --name "hsm1" --location "westus" --network-interfaces private-ip-address="1.0.0.1" --subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --stamp-id "stamp01" --sku "SafeNet Luna Network HSM A790" --tags Dept="hsm" Environment="dogfood" --resource-group "hsm-group"

创建新的或更新现有付款 HSM

az dedicated-hsm create --name "hsm1" --location "westus" --mgmt-network-interfaces private-ip-address="1.0.0.1" --mgmt-network-subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --stamp-id "stamp01" --sku "payShield10K_LMK1_CPS60" --tags Dept="hsm" Environment="dogfood" --resource-group "hsm-group"

使用管理配置文件创建新的或更新现有付款 HSM

az dedicated-hsm create --name "hsm1" --location "westus" --network-interfaces private-ip-address="1.0.0.2" --subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --mgmt-network-interfaces private-ip-address="1.0.0.1" --mgmt-network-subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --stamp-id "stamp02" --sku "payShield10K_LMK1_CPS60" --tags Dept="hsm" Environment="dogfood" --resource-group "hsm-group"

必需参数

--name

专用 Hsm 的名称。

--resource-group -g

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

可选参数

--location -l

Location。 az account list-locations 中的值。可以使用 az configure --defaults location=<location> 配置默认位置。

--mgmt-network-interfaces -m

指定与专用 HSM 关联的网络接口的资源 ID 列表。

用法：--mgmt-network-interfaces private-ip-address=XX

private-ip-address：接口的专用 IP 地址

可以使用多个 --mgmt-network-interfaces 参数指定多个操作。

--mgmt-network-subnet

指定子网的标识符。

用法：--mgmt-network-subnet id=XX

id：采用 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 格式的 ARM 资源 ID。

--network-interfaces -i

指定与专用 HSM 关联的网络接口的资源 ID 列表。

用法：--network-interfaces private-ip-address=XX

private-ip-address：接口的专用 IP 地址

可以使用多个 --network-interfaces 参数指定多个操作。

--no-wait

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

默认值: False

--sku

专用 HSM 的 SKU。

接受的值: SafeNet Luna Network HSM A790, payShield10K_LMK1_CPS250, payShield10K_LMK1_CPS2500, payShield10K_LMK1_CPS60, payShield10K_LMK2_CPS250, payShield10K_LMK2_CPS2500, payShield10K_LMK2_CPS60

--stamp-id

当 RP 不支持可用性区域时，将使用此字段。

--subnet

指定子网的标识符。

用法：--subnet id=XX

id：采用 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 格式的 ARM 资源 ID。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--zones

专用 Hsm 区域。

全局参数

--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 dedicated-hsm delete

删除指定的 Azure 专用 HSM。

az dedicated-hsm delete [--ids]
                        [--name]
                        [--no-wait]
                        [--resource-group]
                        [--subscription]
                        [--yes]

示例

删除专用 HSM

az dedicated-hsm delete --name "hsm1" --resource-group "hsm-group"

可选参数

--ids

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

--name

要删除的专用 HSM 的名称。

--no-wait

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

默认值: False

--resource-group -g

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

--subscription

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

--yes -y

不提示确认。

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

az dedicated-hsm list

列表操作获取与订阅和指定资源组中关联的专用 hsms 的相关信息。 “列表”操作获取与订阅关联的专用 HSM 的相关信息。

az dedicated-hsm list [--resource-group]
                      [--top]

示例

列出资源组中的专用 HSM 设备

az dedicated-hsm list --resource-group "hsm-group"

列出资源组中的专用 HSM 设备，包括付款 HSM

az dedicated-hsm list --resource-group "hsm-group"

列出订阅中的专用 HSM 设备

az dedicated-hsm list

列出订阅中的专用 HSM 设备，包括付款 HSM

az dedicated-hsm list

可选参数

--resource-group -g

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

--top

要返回的结果数上限。

全局参数

--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 dedicated-hsm list-outbound-network-dependency-endpoint

获取指定专用 hsm 资源中的出口终结点（所有出站依赖项的网络终结点）的列表。该操作返回每个出口终结点的属性。

az dedicated-hsm list-outbound-network-dependency-endpoint --name
                                                           --resource-group

示例

按托管群集列出 OutboundNetworkDependenciesEndpoints

az dedicated-hsm list-outbound-network-dependency-endpoint --name "hsm1" --resource-group "hsm-group"

必需参数

--name

专用 HSM 的名称。

--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 dedicated-hsm show

获取指定的 Azure 专用 HSM。

az dedicated-hsm show [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

示例

获取专用 HSM

az dedicated-hsm show --name "hsm1" --resource-group "hsm-group"

获取付款 HSM

az dedicated-hsm show --name "hsm1" --resource-group "hsm-group"

使用 2018-10-31Preview API 版本获取付款 HSM

az dedicated-hsm show --name "hsm1" --resource-group "hsm-group"

可选参数

--ids

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

--name

专用 HSM 的名称。

--resource-group -g

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

--subscription

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

全局参数

--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 dedicated-hsm update

更新指定订阅中的专用 HSM。

az dedicated-hsm update [--ids]
                        [--name]
                        [--no-wait]
                        [--resource-group]
                        [--subscription]
                        [--tags]

示例

更新现有的专用 HSM

az dedicated-hsm update --name "hsm1" --tags Dept="hsm" Environment="dogfood" Slice="A" --resource-group "hsm-group"

更新现有付款 HSM

az dedicated-hsm update --name "hsm1" --tags Dept="hsm" Environment="dogfood" Slice="A" --resource-group "hsm-group"

可选参数

--ids

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

--name

专用 HSM 的名称。

--no-wait

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

默认值: False

--resource-group -g

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

--subscription

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

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数

--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 dedicated-hsm wait

将 CLI 置于等待状态，直到满足专用 hsm 的条件。

az dedicated-hsm wait [--created]
                      [--custom]
                      [--deleted]
                      [--exists]
                      [--ids]
                      [--interval]
                      [--name]
                      [--resource-group]
                      [--subscription]
                      [--timeout]
                      [--updated]

示例

暂停执行下一行 CLI 脚本，直到成功创建 dedicated-hsm。

az dedicated-hsm wait --name "hsm1" --resource-group "hsm-group" --created

暂停执行下一行 CLI 脚本，直到专用 hsm 成功更新。

az dedicated-hsm wait --name "hsm1" --resource-group "hsm-group" --updated

暂停执行下一行 CLI 脚本，直到成功删除专用 hsm。

az dedicated-hsm wait --name "hsm1" --resource-group "hsm-group" --deleted

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

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

--interval

轮询间隔（以秒为单位）。

默认值: 30

--name

专用 HSM 的名称。

--resource-group -g

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

--subscription

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

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

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

通过

az dedicated-hsm

命令

az dedicated-hsm create

示例

必需参数

可选参数

az dedicated-hsm delete

示例

可选参数

az dedicated-hsm list

示例

可选参数

az dedicated-hsm list-outbound-network-dependency-endpoint

示例

必需参数

az dedicated-hsm show

示例

可选参数

az dedicated-hsm update

示例

可选参数

az dedicated-hsm wait

示例

可选参数

其他资源