Microsoft.KeyVault managedHSMs 2021-10-01
Определение ресурса Bicep
Тип ресурса managedHSM можно развернуть в:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.KeyVault/managedHSM, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.KeyVault/managedHSMs@2021-10-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
family: 'B'
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'
}
}
Значения свойств
managedHSMs
| Имя | Описание | Значение |
|---|---|---|
| name | имя ресурса. | строка (обязательно) |
| location | Поддерживаемая служба Azure, в которой должен быть создан пул управляемых устройств HSM. | строка |
| tags | Теги ресурсов | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
| sku | Сведения о номере SKU | ManagedHsmSku |
| properties | Свойства управляемого модуля HSM | ManagedHsmProperties |
ManagedHsmProperties
| Имя | Описание | Значение |
|---|---|---|
| createMode | Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса. | "default" "recover" |
| enablePurgeProtection | Свойство, указывающее, включена ли защита от очистки для этого управляемого пула HSM. Если задать для этого свойства значение true, активируется защита от очистки для этого пула управляемого модуля HSM и его содержимого. Только служба управляемого устройства HSM может инициировать жесткое, неустранимое удаление. Параметр действует только в том случае, если также включено обратимое удаление. Включение этой функции необратимо. | bool |
| enableSoftDelete | Свойство , указываемое, включена ли функция обратимого удаления для этого управляемого пула HSM. Если при создании нового пула управляемых устройств HSM не задано значение (true или false), по умолчанию ему будет присвоено значение true. Если задано значение true, его нельзя вернуть к false. | bool |
| initialAdminObjectIds | Массив начальных идентификаторов объектов администраторов для этого управляемого пула HSM. | string[] |
| networkAcls | Правила, управляющие доступностью хранилища ключей из определенных сетевых расположений. | MhsmNetworkRuleSet |
| publicNetworkAccess | Разрешение на управление трафиком плоскости данных, поступающим из общедоступных сетей, пока включена частная конечная точка. | "Отключено" "Включено" |
| softDeleteRetentionInDays | softDelete data retention days. Он принимает >значения =7 и <=90. | INT |
| tenantId | Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к управляемому пулу HSM. | строка |
MhsmNetworkRuleSet
| Имя | Описание | Значение |
|---|---|---|
| Обход | Сообщает, какой трафик может обходить сетевые правила. Это может быть AzureServices или None. Если значение не указано, значение по умолчанию — "AzureServices". | AzureServices "Нет" |
| defaultAction | Действие по умолчанию, если ни один из правил ipRules и virtualNetworkRules не совпадает. Используется только после вычисления свойства обхода. | "Разрешить" "Deny" |
| ipRules | Список правил IP-адресов. | MhsmipRule[] |
| virtualNetworkRules | Список правил виртуальной сети. | MhsmVirtualNetworkRule[] |
MhsmipRule
| Имя | Описание | Значение |
|---|---|---|
| значение | Диапазон адресов IPv4 в нотации CIDR, например 124.56.78.91 (простой IP-адрес) или 124.56.78.0/24 (все адреса, начинающиеся с 124.56.78). | string (обязательно) |
MhsmVirtualNetworkRule
| Имя | Описание | Значение |
|---|---|---|
| идентификатор | Полный идентификатор ресурса подсети виртуальной сети, например "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". | string (обязательно) |
ManagedHsmSku
| Имя | Описание | Значение |
|---|---|---|
| family | Семейство SKU управляемого пула HSM | "B" (обязательно) |
| name | SKU управляемого пула HSM | 'Custom_B32' "Standard_B1" (обязательно) |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
Создание управляемого устройства HSM Key Vault Azure |
Этот шаблон создает управляемый модуль HSM azure Key Vault. |
Определение ресурса шаблона ARM
Тип ресурса managedHSM можно развернуть в следующих объектах:
- Группы ресурсов — см. команды развертывания групп ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.KeyVault/managedHSM, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.KeyVault/managedHSMs",
"apiVersion": "2021-10-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"family": "B",
"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"
}
}
Значения свойств
managedHSMs
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | Microsoft.KeyVault/managedHSM |
| версия_API | Версия API ресурсов | '2021-10-01' |
| name | имя ресурса. | string (обязательно) |
| location | Поддерживаемая служба Azure, в которой должен быть создан управляемый пул HSM. | строка |
| tags | Теги ресурсов | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
| sku | Сведения о номере SKU | ManagedHsmSku |
| properties | Свойства управляемого модуля HSM | ManagedHsmProperties |
ManagedHsmProperties
| Имя | Описание | Значение |
|---|---|---|
| createMode | Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса. | "default" "восстановить" |
| enablePurgeProtection | Свойство, указывающее, включена ли защита от очистки для этого управляемого пула HSM. Если установить для этого свойства значение true, активируется защита от очистки для этого пула управляемого модуля HSM и его содержимого. Только служба управляемого модуля HSM может инициировать жесткое, безвозвратное удаление. Параметр действует только в том случае, если также включено обратимое удаление. Включение этой функции необратимо. | bool |
| enableSoftDelete | Свойство , указывая, включена ли функция обратимого удаления для этого управляемого пула HSM. Если при создании нового управляемого пула HSM не задано значение (true или false), по умолчанию ему будет присвоено значение true. Если задано значение true, его нельзя вернуть к false. | bool |
| initialAdminObjectIds | Массив начальных идентификаторов объектов администраторов для этого управляемого пула HSM. | string[] |
| networkAcls | Правила, определяющие доступность хранилища ключей из определенных сетевых расположений. | MhsmNetworkRuleSet |
| publicNetworkAccess | Управление разрешением для трафика плоскости данных, поступающего из общедоступных сетей, при этом включена частная конечная точка. | "Отключено" "Включено" |
| softDeleteRetentionInDays | softDelete data retention days. Он принимает >значения =7 и <=90. | INT |
| tenantId | Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к управляемому пулу HSM. | строка |
MhsmNetworkRuleSet
| Имя | Описание | Значение |
|---|---|---|
| Обход | Сообщает, какой трафик может обходить сетевые правила. Это может быть AzureServices или None. Если значение не указано, значение по умолчанию — "AzureServices". | AzureServices "Нет" |
| defaultAction | Действие по умолчанию, если ни один из правил ipRules и virtualNetworkRules не совпадает. Используется только после вычисления свойства обхода. | "Разрешить" "Deny" |
| ipRules | Список правил IP-адресов. | MhsmipRule[] |
| virtualNetworkRules | Список правил виртуальной сети. | MhsmVirtualNetworkRule[] |
MhsmipRule
| Имя | Описание | Значение |
|---|---|---|
| значение | Диапазон адресов IPv4 в нотации CIDR, например 124.56.78.91 (простой IP-адрес) или 124.56.78.0/24 (все адреса, начинающиеся с 124.56.78). | строка (обязательно) |
MhsmVirtualNetworkRule
| Имя | Описание | Значение |
|---|---|---|
| идентификатор | Полный идентификатор ресурса подсети виртуальной сети, например "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnets/subnet1". | строка (обязательно) |
ManagedHsmSku
| Имя | Описание | Значение |
|---|---|---|
| family | Семейство SKU управляемого пула HSM | "B" (обязательно) |
| name | SKU управляемого пула HSM | "Custom_B32" "Standard_B1" (обязательно) |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
| Создание управляемого модуля HSM Key Vault Azure |
Этот шаблон создает управляемый модуль HSM Azure Key Vault. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса managedHSM можно развернуть в:
- Группы ресурсов
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.KeyVault/managedHSMs, добавьте в шаблон следующую terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/managedHSMs@2021-10-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
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"
}
sku = {
family = "B"
name = "string"
}
})
}
Значения свойств
managedHSMs
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | "Microsoft.KeyVault/managedHSMs@2021-10-01" |
| name | имя ресурса. | строка (обязательно) |
| location | Поддерживаемая служба Azure, в которой должен быть создан пул управляемых устройств HSM. | строка |
| parent_id | Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов. | строка (обязательно) |
| tags | Теги ресурсов | Словарь имен и значений тегов. |
| sku | Сведения о номере SKU | ManagedHsmSku |
| properties | Свойства управляемого модуля HSM | ManagedHsmProperties |
ManagedHsmProperties
| Имя | Описание | Значение |
|---|---|---|
| createMode | Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса. | «по умолчанию» "recover" |
| enablePurgeProtection | Свойство, указывающее, включена ли защита от очистки для этого управляемого пула HSM. Если задать для этого свойства значение true, активируется защита от очистки для этого пула управляемого модуля HSM и его содержимого. Только служба управляемого устройства HSM может инициировать жесткое, неустранимое удаление. Параметр действует только в том случае, если также включено обратимое удаление. Включение этой функции необратимо. | bool |
| enableSoftDelete | Свойство , указываемое, включена ли функция обратимого удаления для этого управляемого пула HSM. Если при создании нового пула управляемых устройств HSM не задано значение (true или false), по умолчанию ему будет присвоено значение true. Если задано значение true, его нельзя вернуть к false. | bool |
| initialAdminObjectIds | Массив начальных идентификаторов объектов администраторов для этого управляемого пула HSM. | string[] |
| networkAcls | Правила, управляющие доступностью хранилища ключей из определенных сетевых расположений. | MhsmNetworkRuleSet |
| publicNetworkAccess | Разрешение на управление трафиком плоскости данных, поступающим из общедоступных сетей, пока включена частная конечная точка. | "Отключено" "Включено" |
| softDeleteRetentionInDays | softDelete data retention days. Он принимает >значения =7 и <=90. | INT |
| tenantId | Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к управляемому пулу HSM. | строка |
MhsmNetworkRuleSet
| Имя | Описание | Значение |
|---|---|---|
| Обход | Сообщает, какой трафик может обходить сетевые правила. Это может быть AzureServices или None. Если значение не указано, значение по умолчанию — "AzureServices". | AzureServices "None" |
| defaultAction | Действие по умолчанию, если ни один из правил ipRules и virtualNetworkRules не совпадает. Используется только после вычисления свойства обхода. | "Разрешить" "Запретить" |
| ipRules | Список правил IP-адресов. | MhsmipRule[] |
| virtualNetworkRules | Список правил виртуальной сети. | MhsmVirtualNetworkRule[] |
MhsmipRule
| Имя | Описание | Значение |
|---|---|---|
| значение | Диапазон адресов IPv4 в нотации CIDR, например 124.56.78.91 (простой IP-адрес) или 124.56.78.0/24 (все адреса, начинающиеся с 124.56.78). | строка (обязательно) |
MhsmVirtualNetworkRule
| Имя | Описание | Значение |
|---|---|---|
| идентификатор | Полный идентификатор ресурса подсети виртуальной сети, например "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnets/subnet1". | строка (обязательно) |
ManagedHsmSku
| Имя | Описание | Значение |
|---|---|---|
| family | Семейство SKU управляемого пула HSM | "B" (обязательно) |
| name | SKU управляемого пула HSM | "Custom_B32" "Standard_B1" (обязательно) |
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по