Microsoft.KeyVault managedHSMs 2024-11-01

Статья
01/28/2025

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

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

группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2024-11-01' = {
  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'
        }
      ]
      virtualNetworkRules: [
        {
          id: 'string'
        }
      ]
    }
    publicNetworkAccess: 'string'
    regions: [
      {
        isPrimary: bool
        name: 'string'
      }
    ]
    softDeleteRetentionInDays: int
    tenantId: 'string'
  }
  sku: {
    family: 'string'
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

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

ManagedHsmProperties

Имя	Описание	Ценность
createMode	Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса.	"по умолчанию" "восстановление"
enablePurgeProtection	Свойство, указывающее, включена ли защита от очистки для этого управляемого пула HSM. Установка этого свойства на значение true активирует защиту от очистки для этого управляемого пула HSM и его содержимого— только управляемая служба HSM может инициировать жесткое, безвозвратное удаление. Включение этой функции необратимо.	bool
enableSoftDelete	Свойство, указываемое, включена ли функция обратимого удаления для этого управляемого пула HSM. Обратимое удаление включено по умолчанию для всех управляемых HSM и неизменяемо.	bool
initialAdminObjectIds	Массив идентификаторов объектов начальных администраторов для этого управляемого пула hsm.	string[]
networkAcls	Правила, управляющие специальными возможностями хранилища ключей из определенных сетевых расположений.	MhsmNetworkRuleSet
publicNetworkAccess	Управление разрешением на управляемый HSM из общедоступных сетей.	"Отключено" "Включено"
Регионах	Список всех регионов, связанных с управляемым пулом hsm.	MhsmGeoReplicatedRegion[]
softDeleteRetentionInDays	Обратимое удаление дней хранения данных. При удалении HSM или ключа он будет оставаться восстановленным в течение настроенного периода хранения или в течение 90 дней по умолчанию. Он принимает значения от 7 до 90.	int
tenantId	Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к управляемому пулу HSM.	струна Ограничения целостности: Минимальная длина = 36 Максимальная длина = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

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

ManagedHsmSku

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

ManagedServiceIdentity

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

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

MhsmVirtualNetworkRule

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

Microsoft.KeyVault/managedHSMs

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

UserAssignedIdentities

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

UserAssignedIdentity

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

Примеры краткого руководства

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

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

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

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

группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2024-11-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"
        }
      ],
      "virtualNetworkRules": [
        {
          "id": "string"
        }
      ]
    },
    "publicNetworkAccess": "string",
    "regions": [
      {
        "isPrimary": "bool",
        "name": "string"
      }
    ],
    "softDeleteRetentionInDays": "int",
    "tenantId": "string"
  },
  "sku": {
    "family": "string",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

ManagedHsmProperties

Имя	Описание	Ценность
createMode	Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса.	"по умолчанию" "восстановление"
enablePurgeProtection	Свойство, указывающее, включена ли защита от очистки для этого управляемого пула HSM. Установка этого свойства на значение true активирует защиту от очистки для этого управляемого пула HSM и его содержимого— только управляемая служба HSM может инициировать жесткое, безвозвратное удаление. Включение этой функции необратимо.	bool
enableSoftDelete	Свойство, указываемое, включена ли функция обратимого удаления для этого управляемого пула HSM. Обратимое удаление включено по умолчанию для всех управляемых HSM и неизменяемо.	bool
initialAdminObjectIds	Массив идентификаторов объектов начальных администраторов для этого управляемого пула hsm.	string[]
networkAcls	Правила, управляющие специальными возможностями хранилища ключей из определенных сетевых расположений.	MhsmNetworkRuleSet
publicNetworkAccess	Управление разрешением на управляемый HSM из общедоступных сетей.	"Отключено" "Включено"
Регионах	Список всех регионов, связанных с управляемым пулом hsm.	MhsmGeoReplicatedRegion[]
softDeleteRetentionInDays	Обратимое удаление дней хранения данных. При удалении HSM или ключа он будет оставаться восстановленным в течение настроенного периода хранения или в течение 90 дней по умолчанию. Он принимает значения от 7 до 90.	int
tenantId	Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к управляемому пулу HSM.	струна Ограничения целостности: Минимальная длина = 36 Максимальная длина = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

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

ManagedHsmSku

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

ManagedServiceIdentity

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

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

MhsmVirtualNetworkRule

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

Microsoft.KeyVault/managedHSMs

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

UserAssignedIdentities

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

UserAssignedIdentity

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

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

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

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

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

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

групп ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2024-11-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  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"
      regions = [
        {
          isPrimary = bool
          name = "string"
        }
      ]
      softDeleteRetentionInDays = int
      tenantId = "string"
    }
  })
}

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

ManagedHsmProperties

Имя	Описание	Ценность
createMode	Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса.	"по умолчанию" "восстановление"
enablePurgeProtection	Свойство, указывающее, включена ли защита от очистки для этого управляемого пула HSM. Установка этого свойства на значение true активирует защиту от очистки для этого управляемого пула HSM и его содержимого— только управляемая служба HSM может инициировать жесткое, безвозвратное удаление. Включение этой функции необратимо.	bool
enableSoftDelete	Свойство, указываемое, включена ли функция обратимого удаления для этого управляемого пула HSM. Обратимое удаление включено по умолчанию для всех управляемых HSM и неизменяемо.	bool
initialAdminObjectIds	Массив идентификаторов объектов начальных администраторов для этого управляемого пула hsm.	string[]
networkAcls	Правила, управляющие специальными возможностями хранилища ключей из определенных сетевых расположений.	MhsmNetworkRuleSet
publicNetworkAccess	Управление разрешением на управляемый HSM из общедоступных сетей.	"Отключено" "Включено"
Регионах	Список всех регионов, связанных с управляемым пулом hsm.	MhsmGeoReplicatedRegion[]
softDeleteRetentionInDays	Обратимое удаление дней хранения данных. При удалении HSM или ключа он будет оставаться восстановленным в течение настроенного периода хранения или в течение 90 дней по умолчанию. Он принимает значения от 7 до 90.	int
tenantId	Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к управляемому пулу HSM.	струна Ограничения целостности: Минимальная длина = 36 Максимальная длина = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

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

ManagedHsmSku

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

ManagedServiceIdentity

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

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

MhsmVirtualNetworkRule

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

Microsoft.KeyVault/managedHSMs

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

UserAssignedIdentities

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

UserAssignedIdentity

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

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

Microsoft.KeyVault managedHSMs 2024-11-01

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

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

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

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Примеры краткого руководства

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

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

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

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

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

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

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

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

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

Обратная связь

Дополнительные ресурсы