通过

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

Microsoft.KeyVault managedHSM 2020-04-01-preview

  • 项目

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2020-04-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    createMode: 'string'
    enablePurgeProtection: bool
    enableSoftDelete: bool
    initialAdminObjectIds: [
      '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[]
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”
“Standard_B1”（必需）

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": "2020-04-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "createMode": "string",
    "enablePurgeProtection": "bool",
    "enableSoftDelete": "bool",
    "initialAdminObjectIds": [ "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[]
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”
“Standard_B1”（必需）

Microsoft.KeyVault/managedHSM

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

快速入门模板

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

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

部署到 Azure 		此模板创建 Azure Key Vault 托管 HSM。

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2020-04-01-preview"
  name = "string"
  location = "string"
  sku = {
    family = "string"
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      createMode = "string"
      enablePurgeProtection = bool
      enableSoftDelete = bool
      initialAdminObjectIds = [
        "string"
      ]
      softDeleteRetentionInDays = int
      tenantId = "string"
    }
  })
}

属性值

ManagedHsmProperties

名字 描述 价值
createMode 用于指示正在创建资源还是正在从已删除的资源恢复的创建模式。 “default”
“recover”
enablePurgeProtection 指定是否为此托管 HSM 池启用了针对清除的保护的属性。 将此属性设置为 true 可激活针对此托管 HSM 池及其内容的清除保护 - 只有托管 HSM 服务可能会启动难以、不可恢复的删除。 启用此功能不可逆。 bool
enableSoftDelete 用于指定是否为此托管 HSM 池启用了“软删除”功能的属性。 默认为所有托管 HSM 启用软删除，并且不可变。 bool
initialAdminObjectIds 此托管 hsm 池的初始管理员对象 ID 数组。 string[]
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”
“Standard_B1”（必需）

Microsoft.KeyVault/managedHSM

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