Microsoft.KeyVault managedHSMs 2020-04-01-preview

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

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

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

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

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2020-04-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    family: 'B'
    name: 'string'
  }
  properties: {
    createMode: 'string'
    enablePurgeProtection: bool
    enableSoftDelete: bool
    initialAdminObjectIds: [
      '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 и неизменяемо. bool
initialAdminObjectIds Массив начальных идентификаторов объектов администраторов для этого управляемого пула HSM. string[]
softDeleteRetentionInDays Обратимо удаленные дни хранения данных. При удалении модуля HSM или ключа он будет оставаться восстановленным в течение настроенного периода хранения или периода по умолчанию, равного 90 дням. Он принимает значения от 7 до 90. INT
tenantId Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к управляемому пулу HSM. строка

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

ManagedHsmSku

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

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

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

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

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

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

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

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

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

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

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2020-04-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "family": "B",
    "name": "string"
  },
  "properties": {
    "createMode": "string",
    "enablePurgeProtection": "bool",
    "enableSoftDelete": "bool",
    "initialAdminObjectIds": [ "string" ],
    "softDeleteRetentionInDays": "int",
    "tenantId": "string"
  }
}

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

managedHSMs

Имя Описание Значение
тип Тип ресурса Microsoft.KeyVault/managedHSMs
версия_API Версия API ресурсов '2020-04-01-preview'
name имя ресурса. строка (обязательно)
location Поддерживаемая служба Azure, в которой должен быть создан пул управляемых устройств HSM. строка
tags Теги ресурсов Словарь имен и значений тегов. См . раздел Теги в шаблонах
sku Сведения о номере SKU ManagedHsmSku
properties Свойства управляемого модуля HSM ManagedHsmProperties

ManagedHsmProperties

Имя Описание Значение
createMode Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса. "default"
"recover"
enablePurgeProtection Свойство, указывающее, включена ли защита от очистки для этого управляемого пула HSM. Установка для этого свойства значения true активирует защиту от очистки для этого пула управляемых устройств HSM и его содержимого. Только служба управляемого устройства HSM может инициировать жесткое, неустранимое удаление. Включение этой функции необратимо. bool
enableSoftDelete Свойство , указываемое, включена ли функция обратимого удаления для этого управляемого пула HSM. Обратимое удаление включено по умолчанию для всех управляемых устройств HSM и неизменяемо. bool
initialAdminObjectIds Массив начальных идентификаторов объектов администраторов для этого управляемого пула HSM. string[]
softDeleteRetentionInDays Обратимо удаленные дни хранения данных. При удалении модуля HSM или ключа он будет оставаться восстановленным в течение настроенного периода хранения или периода по умолчанию, равного 90 дням. Он принимает значения от 7 до 90. INT
tenantId Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к управляемому пулу HSM. строка

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

ManagedHsmSku

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

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

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

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

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

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

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

  • Группы ресурсов

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

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

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

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

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

managedHSMs

Имя Описание Значение
тип Тип ресурса "Microsoft.KeyVault/managedHSMs@2020-04-01-preview"
name имя ресурса. строка (обязательно)
location Поддерживаемая служба Azure, в которой должен быть создан пул управляемых устройств HSM. строка
parent_id Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов. строка (обязательно)
tags Теги ресурсов Словарь имен и значений тегов.
sku Сведения о номере SKU ManagedHsmSku
properties Свойства управляемого модуля HSM ManagedHsmProperties

ManagedHsmProperties

Имя Описание Значение
createMode Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса. «по умолчанию»
"восстановить"
enablePurgeProtection Свойство, указывающее, включена ли защита от очистки для этого управляемого пула HSM. Если установить для этого свойства значение true, активируется защита от очистки для этого пула управляемого устройства HSM и его содержимого. Только служба управляемого модуля HSM может инициировать жесткое, безвозвратное удаление. Включение этой функции необратимо. bool
enableSoftDelete Свойство , указывая, включена ли функция обратимого удаления для этого управляемого пула HSM. Обратимое удаление включено по умолчанию для всех управляемых модулей HSM и неизменяемо. bool
initialAdminObjectIds Массив начальных идентификаторов объектов администраторов для этого управляемого пула HSM. string[]
softDeleteRetentionInDays Обратимо удаленные данные в днях хранения. При удалении модуля HSM или ключа они остаются пригодными для восстановления в течение настроенного периода хранения или периода по умолчанию в 90 дней. Он принимает значения от 7 до 90. INT
tenantId Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к управляемому пулу HSM. строка

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

ManagedHsmSku

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