Поделиться через


Управляемые виртуальные машины Microsoft.KeyVault

Определение ресурсов Bicep

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

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

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

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2025-05-01' = {
  scope: resourceSymbolicName or scope
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    createMode: 'string'
    enablePurgeProtection: bool
    enableSoftDelete: bool
    initialAdminObjectIds: [
      'string'
    ]
    networkAcls: {
      bypass: 'string'
      defaultAction: 'string'
      ipRules: [
        {
          value: 'string'
        }
      ]
      serviceTags: [
        {
          tag: 'string'
        }
      ]
      virtualNetworkRules: [
        {
          id: 'string'
        }
      ]
    }
    publicNetworkAccess: 'string'
    regions: [
      {
        isPrimary: bool
        name: 'string'
      }
    ]
    softDeleteRetentionInDays: int
    tenantId: 'string'
  }
  sku: {
    family: 'string'
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

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

Microsoft.KeyVault/managedHSM

Имя Описание Ценность
тождество Удостоверение управляемой службы ManagedServiceIdentity (Управляемый сервисИдентификация)
местоположение Географическое расположение, в котором находится ресурс струна
имя Имя ресурса строка (обязательно)
свойства Свойства управляемого устройства HSM ManagedHsmProperties
scope Используется при создании ресурса в области, отличной от области развертывания. Задайте для этого свойства символьное имя ресурса, чтобы применить ресурс расширения.
SKU Сведения о номере SKU ManagedHsmSku
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

ManagedHsmProperties

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

ManagedHsmSku

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

Управляемые теги Hsm

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

Управляемая служебная идентичность

Имя Описание Ценность
тип Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned). "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned (обязательно)
ИдентичностиНазначенныеПользователем Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах. UserAssignedIdentity (Пользовательские идентификаторы)

MhsmGeoReplicatedRegion

Имя Описание Ценность
isPrimary Логическое значение, указывающее, является ли регион основным регионом или дополнительным регионом. булевая переменная (bool)
имя Имя геореплицированного региона. струна

Правило 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[]
ServiceTags Список тегов сервиса. Правило MhsmServiceTagRule[]
virtualNetworkRules Список правил виртуальной сети. MhsmVirtualNetworkRule[]

Правило MhsmServiceTagRule

Имя Описание Ценность
tag Имя сервисного тега. строка (обязательно)

MhsmVirtualNetworkRule

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

UserAssignedIdentity (Пользовательские идентификаторы)

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

Пользовательская назначенная идентичность

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

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

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

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

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

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

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

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

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

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

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

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

Microsoft.KeyVault/managedHSM

Имя Описание Ценность
apiVersion Версия API '2025-05-01'
тождество Удостоверение управляемой службы ManagedServiceIdentity (Управляемый сервисИдентификация)
местоположение Географическое расположение, в котором находится ресурс струна
имя Имя ресурса строка (обязательно)
свойства Свойства управляемого устройства 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 из общедоступных сетей. "Отключено"
"Включено"
Регионах Список всех регионов, связанных с управляемым пулом hsm. MhsmGeoReplicatedRegion[]
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}$

ManagedHsmSku

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

Управляемые теги Hsm

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

Управляемая служебная идентичность

Имя Описание Ценность
тип Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned). "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned (обязательно)
ИдентичностиНазначенныеПользователем Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах. UserAssignedIdentity (Пользовательские идентификаторы)

MhsmGeoReplicatedRegion

Имя Описание Ценность
isPrimary Логическое значение, указывающее, является ли регион основным регионом или дополнительным регионом. булевая переменная (bool)
имя Имя геореплицированного региона. струна

Правило 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[]
ServiceTags Список тегов сервиса. Правило MhsmServiceTagRule[]
virtualNetworkRules Список правил виртуальной сети. MhsmVirtualNetworkRule[]

Правило MhsmServiceTagRule

Имя Описание Ценность
tag Имя сервисного тега. строка (обязательно)

MhsmVirtualNetworkRule

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

UserAssignedIdentity (Пользовательские идентификаторы)

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

Пользовательская назначенная идентичность

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

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

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

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

Шаблон Описание
создание управляемого HSM в Azure Key Vault

развертывание в Azure
Этот шаблон создает управляемый HSM в Azure Key Vault.

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2025-05-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "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"
          }
        ]
        serviceTags = [
          {
            tag = "string"
          }
        ]
        virtualNetworkRules = [
          {
            id = "string"
          }
        ]
      }
      publicNetworkAccess = "string"
      regions = [
        {
          isPrimary = bool
          name = "string"
        }
      ]
      softDeleteRetentionInDays = int
      tenantId = "string"
    }
    sku = {
      family = "string"
      name = "string"
    }
  }
}

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

Microsoft.KeyVault/managedHSM

Имя Описание Ценность
тождество Удостоверение управляемой службы ManagedServiceIdentity (Управляемый сервисИдентификация)
местоположение Географическое расположение, в котором находится ресурс струна
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса для применения этого ресурса расширения. строка (обязательно)
свойства Свойства управляемого устройства HSM ManagedHsmProperties
SKU Сведения о номере SKU ManagedHsmSku
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.KeyVault/managedHSMs@2025-05-01"

ManagedHsmProperties

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

ManagedHsmSku

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

Управляемые теги Hsm

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

Управляемая служебная идентичность

Имя Описание Ценность
тип Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned). "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned (обязательно)
ИдентичностиНазначенныеПользователем Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах. UserAssignedIdentity (Пользовательские идентификаторы)

MhsmGeoReplicatedRegion

Имя Описание Ценность
isPrimary Логическое значение, указывающее, является ли регион основным регионом или дополнительным регионом. булевая переменная (bool)
имя Имя геореплицированного региона. струна

Правило 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[]
ServiceTags Список тегов сервиса. Правило MhsmServiceTagRule[]
virtualNetworkRules Список правил виртуальной сети. MhsmVirtualNetworkRule[]

Правило MhsmServiceTagRule

Имя Описание Ценность
tag Имя сервисного тега. строка (обязательно)

MhsmVirtualNetworkRule

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

UserAssignedIdentity (Пользовательские идентификаторы)

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

Пользовательская назначенная идентичность

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

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

Примеры Terraform

Простой пример развертывания модуля безопасности управляемого оборудования Key Vault.

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    = ["*"]
}