Microsoft.KeyVault managedHSM 2021-10-01

Определение ресурса Bicep

Тип ресурса managedHSMs можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Примеры использования

Примеры Bicep

Базовый пример развертывания управляемого аппаратного модуля Key Vault Hardware Security Module.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource managedHSM 'Microsoft.KeyVault/managedHSMs@2021-10-01' = {
  name: 'kvHsm230630033342437496'
  location: location
  sku: {
    family: 'B'
    name: 'Standard_B1'
  }
  properties: {
    createMode: 'default'
    enablePurgeProtection: false
    enableSoftDelete: true
    initialAdminObjectIds: [
      deployer().objectId
    ]
    publicNetworkAccess: 'Enabled'
    softDeleteRetentionInDays: 90
    tenantId: tenant().tenantId
  }
}

Примеры быстрого запуска Azure

Следующие шаблоны Azure Quickstart содержат Bicep образцов для развертывания этого типа ресурсов.

Bicep-файл Описание
Создать Azure Key Vault управляемый HSM Этот шаблон создаёт Azure Key Vault Managed HSM.

Формат ресурса

Чтобы создать ресурс Microsoft.KeyVault/managedHSM, добавьте следующий Bicep в ваш шаблон.

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2021-10-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'
  }
}

Значения свойств

Microsoft.KeyVault/managedHSM

Имя Описание Ценность
местоположение Поддерживаемое местоположение Azure, где должен быть создан управляемый HSM пул. струна
имя Имя ресурса строка (обязательно)
свойства Свойства управляемого устройства HSM ManagedHsmProperties
SKU Сведения о номере SKU ManagedHsmSku
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

ManagedHsmProperties

Имя Описание Ценность
createMode Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса. "по умолчанию"
"восстановление"
enablePurgeProtection Свойство, указывающее, включена ли защита от очистки для этого управляемого пула HSM. Установка этого свойства на значение true активирует защиту от очистки для этого управляемого пула HSM и его содержимого— только управляемая служба HSM может инициировать жесткое, безвозвратное удаление. Включение этой функции необратимо. булевая переменная (bool)
enableSoftDelete Свойство, указываемое, включена ли функция обратимого удаления для этого управляемого пула HSM. Обратимое удаление включено по умолчанию для всех управляемых HSM и неизменяемо. булевая переменная (bool)
initialAdminObjectIds Массив идентификаторов объектов начальных администраторов для этого управляемого пула hsm. строка[]
networkAcls Правила, управляющие специальными возможностями хранилища ключей из определенных сетевых расположений. MhsmNetworkRuleSet
доступ к публичной сети Управление разрешением на управляемый HSM из общедоступных сетей. "Отключено"
"Включено"
softDeleteRetentionInDays Обратимое удаление дней хранения данных. При удалении HSM или ключа он будет оставаться восстановленным в течение настроенного периода хранения или в течение 90 дней по умолчанию. Он принимает значения от 7 до 90. инт
идентификатор арендатора Идентификатор арендатора Azure Active Directory, который должен использоваться для аутентификации запросов в управляемый пул HSM. струна

Ограничения целостности:
Минимальная длина = 36
Максимальная длина = 36
Шаблон = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ManagedHsmResourceTags

Имя Описание Ценность

ManagedHsmSku

Имя Описание Ценность
семья Семейство SKU управляемого пула HSM "B" (обязательно)
имя SKU управляемого пула HSM "Custom_B32"
"Custom_B6"
"Standard_B1" (обязательно)

Правило MhsmipRule

Имя Описание Ценность
ценность Диапазон адресов IPv4 в нотации CIDR, например "124.56.78.91" (простой IP-адрес) или "124.56.78.0/24" (все адреса, начинающиеся с 124.56.78). строка (обязательно)

MhsmNetworkRuleSet

Имя Описание Ценность
обходить Указывает, какой трафик может обойти правила сети. Это может быть "AzureServices" или "Нет". Если значение по умолчанию не задано, — AzureServices. AzureServices
"Нет"
defaultAction Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода. "Разрешить"
"Запретить"
ipRules Список правил IP-адресов. Правило Mhsmip[]
virtualNetworkRules Список правил виртуальной сети. MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Имя Описание Ценность
идентификатор Полный идентификатор ресурса подсети виртуальной сети, например "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". строка (обязательно)

Определение ресурса шаблона ARM

Тип ресурса managedHSMs можно развернуть с помощью операций, предназначенных для следующих операций:

Примеры использования

Шаблоны быстрого запуска Azure

Следующие Azure шаблоны быстрого запуска развёртают этот тип ресурса.

Шаблон Описание
Создать Azure Key Vault управляемый HSM

Развернуться на Azure
Этот шаблон создаёт Azure Key Vault Managed HSM.

Формат ресурса

Чтобы создать ресурс Microsoft.KeyVault/managedHSMs, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2021-10-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"
  }
}

Значения свойств

Microsoft.KeyVault/managedHSM

Имя Описание Ценность
apiVersion Версия API '2021-10-01'
местоположение Поддерживаемое местоположение Azure, где должен быть создан управляемый HSM пул. струна
имя Имя ресурса строка (обязательно)
свойства Свойства управляемого устройства HSM ManagedHsmProperties
SKU Сведения о номере SKU ManagedHsmSku
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.KeyVault/managedHSMs"

ManagedHsmProperties

Имя Описание Ценность
createMode Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса. "по умолчанию"
"восстановление"
enablePurgeProtection Свойство, указывающее, включена ли защита от очистки для этого управляемого пула HSM. Установка этого свойства на значение true активирует защиту от очистки для этого управляемого пула HSM и его содержимого— только управляемая служба HSM может инициировать жесткое, безвозвратное удаление. Включение этой функции необратимо. булевая переменная (bool)
enableSoftDelete Свойство, указываемое, включена ли функция обратимого удаления для этого управляемого пула HSM. Обратимое удаление включено по умолчанию для всех управляемых HSM и неизменяемо. булевая переменная (bool)
initialAdminObjectIds Массив идентификаторов объектов начальных администраторов для этого управляемого пула hsm. строка[]
networkAcls Правила, управляющие специальными возможностями хранилища ключей из определенных сетевых расположений. MhsmNetworkRuleSet
доступ к публичной сети Управление разрешением на управляемый HSM из общедоступных сетей. "Отключено"
"Включено"
softDeleteRetentionInDays Обратимое удаление дней хранения данных. При удалении HSM или ключа он будет оставаться восстановленным в течение настроенного периода хранения или в течение 90 дней по умолчанию. Он принимает значения от 7 до 90. инт
идентификатор арендатора Идентификатор арендатора Azure Active Directory, который должен использоваться для аутентификации запросов в управляемый пул HSM. струна

Ограничения целостности:
Минимальная длина = 36
Максимальная длина = 36
Шаблон = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ManagedHsmResourceTags

Имя Описание Ценность

ManagedHsmSku

Имя Описание Ценность
семья Семейство SKU управляемого пула HSM "B" (обязательно)
имя SKU управляемого пула HSM "Custom_B32"
"Custom_B6"
"Standard_B1" (обязательно)

Правило MhsmipRule

Имя Описание Ценность
ценность Диапазон адресов IPv4 в нотации CIDR, например "124.56.78.91" (простой IP-адрес) или "124.56.78.0/24" (все адреса, начинающиеся с 124.56.78). строка (обязательно)

MhsmNetworkRuleSet

Имя Описание Ценность
обходить Указывает, какой трафик может обойти правила сети. Это может быть "AzureServices" или "Нет". Если значение по умолчанию не задано, — AzureServices. AzureServices
"Нет"
defaultAction Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода. "Разрешить"
"Запретить"
ipRules Список правил IP-адресов. Правило Mhsmip[]
virtualNetworkRules Список правил виртуальной сети. MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Имя Описание Ценность
идентификатор Полный идентификатор ресурса подсети виртуальной сети, например "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". строка (обязательно)

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса managedHSMs можно развернуть с помощью операций, предназначенных для следующих операций:

Примеры использования

Примеры Terraform

Базовый пример развертывания управляемого аппаратного модуля Key Vault Hardware Security Module.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
    azurerm = {
      source = "hashicorp/azurerm"
    }
  }
}

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

data "azurerm_client_config" "current" {
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "managedHSM" {
  type      = "Microsoft.KeyVault/managedHSMs@2021-10-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "kvHsm230630033342437496"
  location  = var.location
  body = {
    properties = {
      createMode            = "default"
      enablePurgeProtection = false
      enableSoftDelete      = true
      initialAdminObjectIds = [
        data.azurerm_client_config.current.object_id,
      ]
      publicNetworkAccess       = "Enabled"
      softDeleteRetentionInDays = 90
      tenantId                  = data.azurerm_client_config.current.tenant_id
    }
    sku = {
      family = "B"
      name   = "Standard_B1"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Проверенные модули Azure

Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.

Module Описание
Key Vault управляемый HSM Модуль ресурсов AVM для управляемого HSM Key Vault

Формат ресурса

Чтобы создать ресурс Microsoft.KeyVault/managedHSMs, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2021-10-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
    }
  }
}

Значения свойств

Microsoft.KeyVault/managedHSM

Имя Описание Ценность
местоположение Поддерживаемое местоположение Azure, где должен быть создан управляемый HSM пул. струна
имя Имя ресурса строка (обязательно)
свойства Свойства управляемого устройства HSM ManagedHsmProperties
SKU Сведения о номере SKU ManagedHsmSku
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.KeyVault/managedHSMs@2021-10-01"

ManagedHsmProperties

Имя Описание Ценность
createMode Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса. "по умолчанию"
"восстановление"
enablePurgeProtection Свойство, указывающее, включена ли защита от очистки для этого управляемого пула HSM. Установка этого свойства на значение true активирует защиту от очистки для этого управляемого пула HSM и его содержимого— только управляемая служба HSM может инициировать жесткое, безвозвратное удаление. Включение этой функции необратимо. булевая переменная (bool)
enableSoftDelete Свойство, указываемое, включена ли функция обратимого удаления для этого управляемого пула HSM. Обратимое удаление включено по умолчанию для всех управляемых HSM и неизменяемо. булевая переменная (bool)
initialAdminObjectIds Массив идентификаторов объектов начальных администраторов для этого управляемого пула hsm. строка[]
networkAcls Правила, управляющие специальными возможностями хранилища ключей из определенных сетевых расположений. MhsmNetworkRuleSet
доступ к публичной сети Управление разрешением на управляемый HSM из общедоступных сетей. "Отключено"
"Включено"
softDeleteRetentionInDays Обратимое удаление дней хранения данных. При удалении HSM или ключа он будет оставаться восстановленным в течение настроенного периода хранения или в течение 90 дней по умолчанию. Он принимает значения от 7 до 90. инт
идентификатор арендатора Идентификатор арендатора Azure Active Directory, который должен использоваться для аутентификации запросов в управляемый пул HSM. струна

Ограничения целостности:
Минимальная длина = 36
Максимальная длина = 36
Шаблон = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ManagedHsmResourceTags

Имя Описание Ценность

ManagedHsmSku

Имя Описание Ценность
семья Семейство SKU управляемого пула HSM "B" (обязательно)
имя SKU управляемого пула HSM "Custom_B32"
"Custom_B6"
"Standard_B1" (обязательно)

Правило MhsmipRule

Имя Описание Ценность
ценность Диапазон адресов IPv4 в нотации CIDR, например "124.56.78.91" (простой IP-адрес) или "124.56.78.0/24" (все адреса, начинающиеся с 124.56.78). строка (обязательно)

MhsmNetworkRuleSet

Имя Описание Ценность
обходить Указывает, какой трафик может обойти правила сети. Это может быть "AzureServices" или "Нет". Если значение по умолчанию не задано, — AzureServices. AzureServices
"Нет"
defaultAction Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода. "Разрешить"
"Запретить"
ipRules Список правил IP-адресов. Правило Mhsmip[]
virtualNetworkRules Список правил виртуальной сети. MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule

Имя Описание Ценность
идентификатор Полный идентификатор ресурса подсети виртуальной сети, например "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". строка (обязательно)