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

Microsoft.KeyVault managedHSMs 2022-11-01

项目
12/21/2024

Bicep 资源定义

可以使用目标操作部署托管HSM 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.KeyVault/managedHSMs 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2022-11-01' = {
  location: 'string'
  name: 'string'
  properties: {
    createMode: 'string'
    enablePurgeProtection: bool
    enableSoftDelete: bool
    initialAdminObjectIds: [
      'string'
    ]
    networkAcls: {
      bypass: 'string'
      defaultAction: 'string'
      ipRules: [
        {
          value: 'string'
        }
      ]
      virtualNetworkRules: [
        {
          id: 'string'
        }
      ]
    }
    publicNetworkAccess: 'string'
    softDeleteRetentionInDays: int
    tenantId: 'string'
  }
  sku: {
    family: 'string'
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

ManagedHsmProperties

名字	描述	价值
createMode	用于指示正在创建资源还是正在从已删除的资源恢复的创建模式。	“default” “recover”
enablePurgeProtection	指定是否为此托管 HSM 池启用了针对清除的保护的属性。将此属性设置为 true 可激活针对此托管 HSM 池及其内容的清除保护 - 只有托管 HSM 服务可能会启动难以、不可恢复的删除。启用此功能不可逆。	bool
enableSoftDelete	用于指定是否为此托管 HSM 池启用了“软删除”功能的属性。默认为所有托管 HSM 启用软删除，并且不可变。	bool
initialAdminObjectIds	此托管 hsm 池的初始管理员对象 ID 数组。	string[]
networkAcls	控制从特定网络位置访问密钥保管库的可访问性的规则。	MhsmNetworkRuleSet
publicNetworkAccess	从公用网络控制对托管 HSM 的权限。	“Disabled” “Enabled”
softDeleteRetentionInDays	软删除的数据保留天数。删除 HSM 或密钥时，它将在配置的保留期或默认的 90 天内保持可恢复。它接受介于 7 和 90 之间的值。	int
tenantId	应用于对托管 HSM 池的请求进行身份验证的 Azure Active Directory 租户 ID。	字符串约束：最小长度 = 36 最大长度 = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

名字	描述	价值

ManagedHsmSku

名字	描述	价值
家庭	托管 HSM 池的 SKU 系列	“B”（必需）
名字	托管 HSM 池的 SKU	“Custom_B32” “Custom_B6” “Standard_B1”（必需）

MhsmipRule

名字	描述	价值
价值	CIDR 表示法中的 IPv4 地址范围，例如“124.56.78.91”（简单 IP 地址）或“124.56.78.0/24”（以 124.56.78 开头的所有地址）。	string （必需）

MhsmNetworkRuleSet

名字	描述	价值
旁路	告知哪些流量可以绕过网络规则。这可以是“AzureServices”或“None”。如果未指定默认值，则为“AzureServices”。	“AzureServices” “None”
defaultAction	当没有来自 ipRules 和 virtualNetworkRules 的规则匹配时，默认操作。仅当评估绕过属性后，才使用此属性。	“允许” “拒绝”
ipRules	IP 地址规则的列表。	MhsmipRule[]
virtualNetworkRules	虚拟网络规则的列表。	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

名字	描述	价值
id	vnet 子网的完整资源 ID，例如“/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1”。	string （必需）

Microsoft.KeyVault/managedHSM

名字	描述	价值
位置	应在其中创建托管 HSM 池的受支持 Azure 位置。	字符串
名字	资源名称	string （必需）
性能	托管 HSM 的属性	ManagedHsmProperties
sku	SKU 详细信息	ManagedHsmSku
标签	资源标记	标记名称和值的字典。请参阅模板中的标记

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
创建 Azure Key Vault 托管 HSM	此模板创建 Azure Key Vault 托管 HSM。

ARM 模板资源定义

可以使用目标操作部署托管HSM 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.KeyVault/managedHSM 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2022-11-01",
  "name": "string",
  "location": "string",
  "properties": {
    "createMode": "string",
    "enablePurgeProtection": "bool",
    "enableSoftDelete": "bool",
    "initialAdminObjectIds": [ "string" ],
    "networkAcls": {
      "bypass": "string",
      "defaultAction": "string",
      "ipRules": [
        {
          "value": "string"
        }
      ],
      "virtualNetworkRules": [
        {
          "id": "string"
        }
      ]
    },
    "publicNetworkAccess": "string",
    "softDeleteRetentionInDays": "int",
    "tenantId": "string"
  },
  "sku": {
    "family": "string",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

ManagedHsmProperties

名字	描述	价值
createMode	用于指示正在创建资源还是正在从已删除的资源恢复的创建模式。	“default” “recover”
enablePurgeProtection	指定是否为此托管 HSM 池启用了针对清除的保护的属性。将此属性设置为 true 可激活针对此托管 HSM 池及其内容的清除保护 - 只有托管 HSM 服务可能会启动难以、不可恢复的删除。启用此功能不可逆。	bool
enableSoftDelete	用于指定是否为此托管 HSM 池启用了“软删除”功能的属性。默认为所有托管 HSM 启用软删除，并且不可变。	bool
initialAdminObjectIds	此托管 hsm 池的初始管理员对象 ID 数组。	string[]
networkAcls	控制从特定网络位置访问密钥保管库的可访问性的规则。	MhsmNetworkRuleSet
publicNetworkAccess	从公用网络控制对托管 HSM 的权限。	“Disabled” “Enabled”
softDeleteRetentionInDays	软删除的数据保留天数。删除 HSM 或密钥时，它将在配置的保留期或默认的 90 天内保持可恢复。它接受介于 7 和 90 之间的值。	int
tenantId	应用于对托管 HSM 池的请求进行身份验证的 Azure Active Directory 租户 ID。	字符串约束：最小长度 = 36 最大长度 = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

名字	描述	价值

ManagedHsmSku

名字	描述	价值
家庭	托管 HSM 池的 SKU 系列	“B”（必需）
名字	托管 HSM 池的 SKU	“Custom_B32” “Custom_B6” “Standard_B1”（必需）

MhsmipRule

名字	描述	价值
价值	CIDR 表示法中的 IPv4 地址范围，例如“124.56.78.91”（简单 IP 地址）或“124.56.78.0/24”（以 124.56.78 开头的所有地址）。	string （必需）

MhsmNetworkRuleSet

名字	描述	价值
旁路	告知哪些流量可以绕过网络规则。这可以是“AzureServices”或“None”。如果未指定默认值，则为“AzureServices”。	“AzureServices” “None”
defaultAction	当没有来自 ipRules 和 virtualNetworkRules 的规则匹配时，默认操作。仅当评估绕过属性后，才使用此属性。	“允许” “拒绝”
ipRules	IP 地址规则的列表。	MhsmipRule[]
virtualNetworkRules	虚拟网络规则的列表。	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

名字	描述	价值
id	vnet 子网的完整资源 ID，例如“/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1”。	string （必需）

Microsoft.KeyVault/managedHSM

名字	描述	价值
apiVersion	API 版本	'2022-11-01'
位置	应在其中创建托管 HSM 池的受支持 Azure 位置。	字符串
名字	资源名称	string （必需）
性能	托管 HSM 的属性	ManagedHsmProperties
sku	SKU 详细信息	ManagedHsmSku
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
类型	资源类型	“Microsoft.KeyVault/managedHSM”

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
创建 Azure Key Vault 托管 HSM	此模板创建 Azure Key Vault 托管 HSM。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署托管HSM 资源类型：

资源组

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.KeyVault/managedHSMs 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2022-11-01"
  name = "string"
  location = "string"
  sku = {
    family = "string"
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      createMode = "string"
      enablePurgeProtection = bool
      enableSoftDelete = bool
      initialAdminObjectIds = [
        "string"
      ]
      networkAcls = {
        bypass = "string"
        defaultAction = "string"
        ipRules = [
          {
            value = "string"
          }
        ]
        virtualNetworkRules = [
          {
            id = "string"
          }
        ]
      }
      publicNetworkAccess = "string"
      softDeleteRetentionInDays = int
      tenantId = "string"
    }
  })
}

属性值

ManagedHsmProperties

名字	描述	价值
createMode	用于指示正在创建资源还是正在从已删除的资源恢复的创建模式。	“default” “recover”
enablePurgeProtection	指定是否为此托管 HSM 池启用了针对清除的保护的属性。将此属性设置为 true 可激活针对此托管 HSM 池及其内容的清除保护 - 只有托管 HSM 服务可能会启动难以、不可恢复的删除。启用此功能不可逆。	bool
enableSoftDelete	用于指定是否为此托管 HSM 池启用了“软删除”功能的属性。默认为所有托管 HSM 启用软删除，并且不可变。	bool
initialAdminObjectIds	此托管 hsm 池的初始管理员对象 ID 数组。	string[]
networkAcls	控制从特定网络位置访问密钥保管库的可访问性的规则。	MhsmNetworkRuleSet
publicNetworkAccess	从公用网络控制对托管 HSM 的权限。	“Disabled” “Enabled”
softDeleteRetentionInDays	软删除的数据保留天数。删除 HSM 或密钥时，它将在配置的保留期或默认的 90 天内保持可恢复。它接受介于 7 和 90 之间的值。	int
tenantId	应用于对托管 HSM 池的请求进行身份验证的 Azure Active Directory 租户 ID。	字符串约束：最小长度 = 36 最大长度 = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

名字	描述	价值

ManagedHsmSku

名字	描述	价值
家庭	托管 HSM 池的 SKU 系列	“B”（必需）
名字	托管 HSM 池的 SKU	“Custom_B32” “Custom_B6” “Standard_B1”（必需）

MhsmipRule

名字	描述	价值
价值	CIDR 表示法中的 IPv4 地址范围，例如“124.56.78.91”（简单 IP 地址）或“124.56.78.0/24”（以 124.56.78 开头的所有地址）。	string （必需）

MhsmNetworkRuleSet

名字	描述	价值
旁路	告知哪些流量可以绕过网络规则。这可以是“AzureServices”或“None”。如果未指定默认值，则为“AzureServices”。	“AzureServices” “None”
defaultAction	当没有来自 ipRules 和 virtualNetworkRules 的规则匹配时，默认操作。仅当评估绕过属性后，才使用此属性。	“允许” “拒绝”
ipRules	IP 地址规则的列表。	MhsmipRule[]
virtualNetworkRules	虚拟网络规则的列表。	MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

名字	描述	价值
id	vnet 子网的完整资源 ID，例如“/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1”。	string （必需）

Microsoft.KeyVault/managedHSM

名字	描述	价值
位置	应在其中创建托管 HSM 池的受支持 Azure 位置。	字符串
名字	资源名称	string （必需）
性能	托管 HSM 的属性	ManagedHsmProperties
sku	SKU 详细信息	ManagedHsmSku
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.KeyVault/managedHSMs@2022-11-01”

通过

Microsoft.KeyVault managedHSMs 2022-11-01

Bicep 资源定义

资源格式

属性值

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSM

快速入门示例

ARM 模板资源定义

资源格式

属性值

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSM

快速入门模板

Terraform （AzAPI 提供程序）资源定义

资源格式

属性值

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSM

反馈

其他资源