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

Managed Hsms - Update

参考

服务:: Key Vault

API 版本:: 2022-07-01

更新指定订阅中的托管 HSM 池。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}?api-version=2022-07-01

URI 参数

名称	在	必需	类型	说明
name	path	True	string	托管 HSM 池的名称
resourceGroupName	path	True	string	包含托管 HSM 池的资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

请求正文

名称	类型	说明
location	string	应在其中创建托管 HSM 池的受支持的 Azure 位置。
properties	ManagedHsmProperties	托管 HSM 的属性
sku	ManagedHsmSku	SKU 详细信息
tags	object	资源标记

响应

名称	类型	说明
200 OK	ManagedHsm	修补的托管 HSM 池
202 Accepted	ManagedHsm	已接受，操作将以异步方式完成。标头 Location: string
Other Status Codes	ManagedHsmError	描述操作失败原因的错误响应。

名称

类型

说明

200 OK

ManagedHsm

修补的托管 HSM 池

202 Accepted

ManagedHsm

已接受，操作将以异步方式完成。

标头

Location: string

Other Status Codes

ManagedHsmError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Update an existing managed HSM Pool

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2022-07-01

{
  "tags": {
    "Dept": "hsm",
    "Environment": "dogfood",
    "Slice": "A"
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python managed_hsm_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.managed_hsms.begin_update(
        resource_group_name="hsm-group",
        name="hsm1",
        parameters={"tags": {"Dept": "hsm", "Environment": "dogfood", "Slice": "A"}},
    ).result()
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_Update.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "properties": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "initialAdminObjectIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "enableSoftDelete": false,
    "softDeleteRetentionInDays": 90,
    "enablePurgeProtection": false,
    "hsmUri": "https://westus.hsm1.managedhsm.azure.net",
    "provisioningState": "Succeeded",
    "statusMessage": "ManagedHsm is functional."
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
  "name": "hsm1",
  "type": "Microsoft.KeyVault/managedHSMs",
  "location": "westus",
  "sku": {
    "family": "B",
    "name": "Standard_B1"
  },
  "tags": {
    "Dept": "hsm",
    "Environment": "dogfood",
    "Slice": "A"
  }
}

状态代码:: 202

Location: https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2022-07-01&kv-operation=abJjb2RkIjoiAGVsZXRlTWFuYWdlZEhzbUFzeW5jYm9

{
  "properties": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "initialAdminObjectIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "enableSoftDelete": true,
    "softDeleteRetentionInDays": 90,
    "enablePurgeProtection": false,
    "hsmUri": "https://westus.hsm1.managedhsm.azure.net",
    "provisioningState": "Updating",
    "statusMessage": "ManagedHsm is updating."
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
  "name": "hsm1",
  "type": "Microsoft.KeyVault/managedHSMs",
  "location": "westus",
  "sku": {
    "family": "B",
    "name": "Standard_B1"
  },
  "tags": {
    "Dept": "hsm",
    "Environment": "dogfood",
    "Slice": "A"
  }
}

定义

名称	说明
ActionsRequired	一条消息，指示服务提供商的更改是否需要对使用者进行任何更新。
ActivationStatus	激活状态
CreateMode	创建模式，用于指示资源是正在创建还是正在从已删除的资源中恢复。
Error	服务器错误。
identityType	创建密钥保管库资源的标识类型。
ManagedHsm	包含扩展详细信息的资源信息。
ManagedHsmError	错误异常。
ManagedHsmProperties	托管 HSM 池的属性
ManagedHSMSecurityDomainProperties	托管 hsm 的安全域属性。
ManagedHsmSku	SKU 详细信息
ManagedHsmSkuFamily	托管 HSM 池的 SKU 系列
ManagedHsmSkuName	托管 HSM 池的 SKU
MHSMIPRule	管理托管 hsm 池从特定 IP 地址或 IP 范围的可访问性的规则。
MHSMNetworkRuleSet	管理托管 hsm 池的网络可访问性的一组规则。
MHSMPrivateEndpoint	专用终结点对象属性。
MHSMPrivateEndpointConnectionItem	专用终结点连接项。
MHSMPrivateLinkServiceConnectionState	一个对象，表示专用链接连接的审批状态。
MHSMVirtualNetworkRule	管理特定虚拟网络中托管 hsm 池的可访问性的规则。
NetworkRuleAction	ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。这仅在评估 bypass 属性后使用。
NetworkRuleBypassOptions	告知哪些流量可以绕过网络规则。这可以是“AzureServices”或“None”。如果未指定，则默认值为“AzureServices”。
PrivateEndpointConnectionProvisioningState	专用终结点连接的预配状态。
PrivateEndpointServiceConnectionStatus	指示密钥保管库所有者是否已批准、拒绝或删除连接。
ProvisioningState	预配状态。
PublicNetworkAccess	从公用网络控制对托管 HSM 的权限。
SystemData	与密钥保管库资源的创建和上次修改相关的元数据。

ActionsRequired

一条消息，指示服务提供商的更改是否需要对使用者进行任何更新。

名称	类型	说明
None	string

ActivationStatus

激活状态

名称	类型	说明
Active	string	托管 HSM 池处于活动状态。
Failed	string	无法激活托管 hsm。
NotActivated	string	托管 HSM 池尚未激活。
Unknown	string	激活托管 hsm 时发生未知错误。

CreateMode

创建模式，用于指示资源是正在创建还是正在从已删除的资源中恢复。

名称	类型	说明
default	string	创建新的托管 HSM 池。这是默认选项。
recover	string	从软删除的资源恢复托管 HSM 池。

Error

服务器错误。

名称	类型	说明
code	string	错误代码。
innererror	Error	内部错误包含更具体的错误代码。
message	string	错误消息。

identityType

创建密钥保管库资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

包含扩展详细信息的资源信息。

名称	类型	说明
id	string	托管 HSM 池的 Azure 资源管理器资源 ID。
location	string	应在其中创建托管 HSM 池的受支持 Azure 位置。
name	string	托管 HSM 池的名称。
properties	ManagedHsmProperties	托管 HSM 的属性
sku	ManagedHsmSku	SKU 详细信息
systemData	SystemData	与密钥保管库资源的创建和上次修改相关的元数据。
tags	object	资源标记
type	string	托管 HSM 池的资源类型。

ManagedHsmError

错误异常。

名称	类型	说明
error	Error	服务器错误。

ManagedHsmProperties

托管 HSM 池的属性

名称	类型	默认值	说明
createMode	CreateMode		创建模式，用于指示资源是正在创建还是正在从已删除的资源中恢复。
enablePurgeProtection	boolean	True	指定是否为此托管 HSM 池启用清除防护的属性。将此属性设置为 true 可激活针对此托管 HSM 池及其内容的清除保护 - 只有托管 HSM 服务可能会启动不可恢复的硬删除。启用此功能是不可逆的。
enableSoftDelete	boolean	True	用于指定是否为此托管 HSM 池启用“软删除”功能的属性。默认为所有托管 HSM 启用软删除，并且不可变。
hsmUri	string		用于对密钥执行操作的托管 hsm 池的 URI。
initialAdminObjectIds	string[]		此托管 hsm 池的初始管理员对象 ID 数组。
networkAcls	MHSMNetworkRuleSet		管理来自特定网络位置的密钥保管库可访问性的规则。
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		与托管 hsm 池关联的专用终结点连接列表。
provisioningState	ProvisioningState		预配状态。
publicNetworkAccess	PublicNetworkAccess	Enabled	从公用网络控制对托管 HSM 的权限。
scheduledPurgeDate	string		计划的清除日期（UTC）。
securityDomainProperties	ManagedHSMSecurityDomainProperties		托管 HSM 安全域属性。
softDeleteRetentionInDays	integer	90	软删除的数据保留天数。删除 HSM 或密钥时，它将在配置的保留期或默认 90 天内保持可恢复状态。它接受 7 到 90 之间的值。
statusMessage	string		资源状态消息。
tenantId	string		应用于对托管 HSM 池的请求进行身份验证的 Azure Active Directory 租户 ID。

ManagedHSMSecurityDomainProperties

托管 hsm 的安全域属性。

名称	类型	说明
activationStatus	ActivationStatus	激活状态
activationStatusMessage	string	激活状态消息。

ManagedHsmSku

SKU 详细信息

名称	类型	说明
family	ManagedHsmSkuFamily	托管 HSM 池的 SKU 系列
name	ManagedHsmSkuName	托管 HSM 池的 SKU

ManagedHsmSkuFamily

托管 HSM 池的 SKU 系列

名称	类型	说明
B	string

ManagedHsmSkuName

托管 HSM 池的 SKU

名称	类型	说明
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

管理托管 hsm 池从特定 IP 地址或 IP 范围的可访问性的规则。

名称	类型	说明
value	string	以 CIDR 表示法表示的 IPv4 地址范围，例如“124.56.78.91” (简单 IP 地址) 或“124.56.78.0/24” (以 124.56.78) 开头的所有地址。

MHSMNetworkRuleSet

管理托管 hsm 池的网络可访问性的一组规则。

名称	类型	说明
bypass	NetworkRuleBypassOptions	告知哪些流量可以绕过网络规则。这可以是“AzureServices”或“None”。如果未指定，则默认值为“AzureServices”。
defaultAction	NetworkRuleAction	ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。这仅在评估 bypass 属性后使用。
ipRules	MHSMIPRule[]	IP 地址规则的列表。
virtualNetworkRules	MHSMVirtualNetworkRule[]	虚拟网络规则的列表。

MHSMPrivateEndpoint

专用终结点对象属性。

名称	类型	说明
id	string	专用终结点资源的完整标识符。

MHSMPrivateEndpointConnectionItem

专用终结点连接项。

名称	类型	说明
etag	string	每当专用终结点连接的状态发生更改时修改。
id	string	专用终结点连接的 ID。
properties.privateEndpoint	MHSMPrivateEndpoint	专用终结点对象的属性。
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	专用链接连接的审批状态。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	专用终结点连接的预配状态。

MHSMPrivateLinkServiceConnectionState

一个对象，表示专用链接连接的审批状态。

名称	类型	说明
actionsRequired	ActionsRequired	一条消息，指示服务提供商的更改是否需要对使用者进行任何更新。
description	string	批准或拒绝的原因。
status	PrivateEndpointServiceConnectionStatus	指示连接是否已由密钥保管库所有者批准、拒绝或删除。

MHSMVirtualNetworkRule

管理特定虚拟网络中托管 hsm 池的可访问性的规则。

名称	类型	说明
id	string	vnet 子网的完整资源 ID，例如“/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1”。

NetworkRuleAction

ipRules 和 virtualNetworkRules 中没有规则匹配时的默认操作。这仅在评估 bypass 属性后使用。

名称	类型	说明
Allow	string
Deny	string

NetworkRuleBypassOptions

告知哪些流量可以绕过网络规则。这可以是“AzureServices”或“None”。如果未指定，则默认值为“AzureServices”。

名称	类型	说明
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

专用终结点连接的预配状态。

名称	类型	说明
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

指示密钥保管库所有者是否已批准、拒绝或删除连接。

名称	类型	说明
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

预配状态。

名称	类型	说明
Activated	string	托管 HSM 池已准备好正常使用。
Deleting	string	托管 HSM 池当前正在删除。
Failed	string	托管 HSM 池的预配失败。
Provisioning	string	当前正在预配托管 HSM 池。
Restoring	string	正在从完整 HSM 备份还原托管 HSM 池。
SecurityDomainRestore	string	托管 HSM 池正在等待安全域还原操作。
Succeeded	string	托管 HSM 池已完全预配。
Updating	string	托管 HSM 池当前正在更新。

PublicNetworkAccess

从公用网络控制对托管 HSM 的权限。

名称	类型	说明
Disabled	string
Enabled	string

SystemData

与密钥保管库资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	密钥保管库资源创建的时间戳 (UTC) 。
createdBy	string	创建密钥保管库资源的标识。
createdByType	identityType	创建密钥保管库资源的标识类型。
lastModifiedAt	string	上次修改密钥保管库资源的时间戳 (UTC) 。
lastModifiedBy	string	上次修改密钥保管库资源的标识。
lastModifiedByType	identityType	上次修改密钥保管库资源的标识类型。

通过

Managed Hsms - Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Update an existing managed HSM Pool

示例请求

示例响应

定义

ActionsRequired

ActivationStatus

CreateMode

Error

identityType

ManagedHsm

ManagedHsmError

ManagedHsmProperties

ManagedHSMSecurityDomainProperties

ManagedHsmSku

ManagedHsmSkuFamily

ManagedHsmSkuName

MHSMIPRule

MHSMNetworkRuleSet

MHSMPrivateEndpoint

MHSMPrivateEndpointConnectionItem

MHSMPrivateLinkServiceConnectionState

MHSMVirtualNetworkRule

NetworkRuleAction

NetworkRuleBypassOptions

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SystemData

其他资源