Microsoft.KeyVault managedHSMs/keys 2022-11-01

Статья
04/20/2024

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

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

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

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

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

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs/keys@2022-11-01' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    attributes: {
      enabled: bool
      exp: int
      exportable: bool
      nbf: int
    }
    curveName: 'string'
    keyOps: [
      'string'
    ]
    keySize: int
    kty: 'string'
    release_policy: {
      contentType: 'string'
      data: 'string'
    }
    rotationPolicy: {
      attributes: {
        expiryTime: 'string'
      }
      lifetimeActions: [
        {
          action: {
            type: 'string'
          }
          trigger: {
            timeAfterCreate: 'string'
            timeBeforeExpiry: 'string'
          }
        }
      ]
    }
  }
}

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

managedHSMs/keys

Имя	Описание	Значение
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.	строка (обязательно)
tags	Теги, которые будут назначены ключу.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа: managedHSM
properties	Свойства создаваемого ключа.	ManagedHsmKeyProperties (обязательно)

ManagedHsmKeyProperties

Имя	Описание	Значение
attributes	Атрибуты ключа.	ManagedHsmKeyAttributes
curveName	Имя эллиптической кривой. Допустимые значения см. в разделе JsonWebKeyCurveName.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Массив строк, содержащий любой из: "расшифровка" "encrypt" "import" "release" "sign" unwrapKey "verify" wrapKey
keySize	Размер ключа в битах. Например: 2048, 3072 или 4096 для RSA.	INT
kty	Тип ключа. Допустимые значения см. в разделе JsonWebKeyType.	"EC" EC-HSM RSA RSA-HSM
release_policy	Политика выпуска ключа в ответ. Он будет использоваться как для вывода, так и для входных данных. Опущен, если он пуст	ManagedHsmKeyReleasePolicy
rotationPolicy	Политика смены ключей в ответ. Он будет использоваться как для вывода, так и для входных данных. Опущен, если он пуст	ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

Имя	Описание	Значение
Включено	Определяет, включен ли объект.	bool
exp	Дата окончания срока действия в секундах с 1970-01-01T00:00:00Z.	INT
Экспортируемый	Указывает, можно ли экспортировать закрытый ключ.	bool
nbf	Не раньше даты в секундах с 1970-01-01T00:00:00Z.	INT

ManagedHsmKeyReleasePolicy

Имя	Описание	Значение
сontentType	Тип контента и версия политики выпуска ключа	строка
.	Кодирование BLOB-объектов — правила политики, в соответствии с которыми можно освободить ключ.	строка

ManagedHsmRotationPolicy

Имя	Описание	Значение
attributes	Атрибуты политики смены ключей.	ManagedHsmKeyRotationPolicyAttributes
lifetimeActions	LifetimeActions для действия смены ключей.	ManagedHsmLifetimeAction[]

ManagedHsmKeyRotationPolicyAttributes

Имя	Описание	Значение
expiryTime	Время окончания срока действия для новой версии ключа. Он должен быть в ISO8601 формате. Например: "P90D", "P1Y".	строка

ManagedHsmLifetimeAction

Имя	Описание	Значение
action	Действие lifetimeAction политики смены ключей.	ManagedHsmAction
триггер	Триггер жизненного цикла политики смены ключей.	ManagedHsmTrigger

ManagedHsmAction

Имя	Описание	Значение
тип	Тип действия. Значение должно сравниваться без учета регистра.	Уведомление "Повернуть"

ManagedHsmTrigger

Имя	Описание	Значение
timeAfterCreate	Продолжительность смены ключа после создания ключа. Он применяется только для поворота. Он будет иметь формат длительности ISO 8601. Например: "P90D", "P1Y".	строка
TimeBeforeExpiry	Время, в течение которого истекает срок действия ключа для смены или уведомления. Он будет иметь формат длительности ISO 8601. Например: "P90D", "P1Y".	строка

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

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

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

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

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

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

{
  "type": "Microsoft.KeyVault/managedHSMs/keys",
  "apiVersion": "2022-11-01",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "exportable": "bool",
      "nbf": "int"
    },
    "curveName": "string",
    "keyOps": [ "string" ],
    "keySize": "int",
    "kty": "string",
    "release_policy": {
      "contentType": "string",
      "data": "string"
    },
    "rotationPolicy": {
      "attributes": {
        "expiryTime": "string"
      },
      "lifetimeActions": [
        {
          "action": {
            "type": "string"
          },
          "trigger": {
            "timeAfterCreate": "string",
            "timeBeforeExpiry": "string"
          }
        }
      ]
    }
  }
}

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

managedHSMs/keys

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.KeyVault/managedHSMs/keys
версия_API	Версия API ресурсов	'2022-11-01'
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.	строка (обязательно)
tags	Теги, которые будут назначены ключу.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties	Свойства создаваемого ключа.	ManagedHsmKeyProperties (обязательно)

ManagedHsmKeyProperties

Имя	Описание	Значение
attributes	Атрибуты ключа.	ManagedHsmKeyAttributes
curveName	Имя эллиптической кривой. Допустимые значения см. в разделе JsonWebKeyCurveName.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Массив строк, содержащий любой из: "расшифровка" "encrypt" "import" "release" "sign" unwrapKey "verify" 'wrapKey'
keySize	Размер ключа в битах. Например: 2048, 3072 или 4096 для RSA.	INT
kty	Тип ключа. Допустимые значения см. в разделе JsonWebKeyType.	"EC" EC-HSM 'RSA' "RSA-HSM"
release_policy	Политика выпуска ключей в ответ. Он будет использоваться как для вывода, так и для входных данных. Опущено, если пусто	ManagedHsmKeyReleasePolicy
rotationPolicy	Политика смены ключей в ответ. Он будет использоваться как для вывода, так и для входных данных. Опущено, если пусто	ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

Имя	Описание	Значение
Включено	Определяет, включен ли объект .	bool
exp	Срок действия в секундах с 1970-01-01T00:00:00Z.	INT
Экспортируемый	Указывает, можно ли экспортировать закрытый ключ.	bool
nbf	Не раньше даты в секундах с 1970-01-01T00:00:00Z.	INT

ManagedHsmKeyReleasePolicy

Имя	Описание	Значение
сontentType	Тип контента и версия политики выпуска ключа	строка
.	Кодирование BLOB-объектов правил политики, в соответствии с которыми можно освободить ключ.	строка

ManagedHsmRotationPolicy

Имя	Описание	Значение
attributes	Атрибуты политики смены ключей.	ManagedHsmKeyRotationPolicyAttributes
lifetimeActions	Действие lifetimeActions для действия смены ключей.	ManagedHsmLifetimeAction[]

ManagedHsmKeyRotationPolicyAttributes

Имя	Описание	Значение
expiryTime	Срок действия новой версии ключа. Он должен быть в ISO8601 формате. Например: "P90D", "P1Y".	строка

ManagedHsmLifetimeAction

Имя	Описание	Значение
action	Действие жизненного цикла политики смены ключей.	ManagedHsmAction
триггер	Триггер жизненного цикла политики смены ключей.	ManagedHsmTrigger

ManagedHsmAction

Имя	Описание	Значение
тип	Тип действия. Значение должно сравниваться без учета регистра.	"Уведомить" "Повернуть"

ManagedHsmTrigger

Имя	Описание	Значение
timeAfterCreate	Продолжительность смены ключа после создания ключа. Он применяется только для поворота. Он будет иметь формат длительности ISO 8601. Например: "P90D", "P1Y".	строка
TimeBeforeExpiry	Время, в течение которого истекает срок действия ключа для смены или уведомления. Он будет иметь формат длительности ISO 8601. Например: "P90D", "P1Y".	строка

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs/keys@2022-11-01"
  name = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        exportable = bool
        nbf = int
      }
      curveName = "string"
      keyOps = [
        "string"
      ]
      keySize = int
      kty = "string"
      release_policy = {
        contentType = "string"
        data = "string"
      }
      rotationPolicy = {
        attributes = {
          expiryTime = "string"
        }
        lifetimeActions = [
          {
            action = {
              type = "string"
            }
            trigger = {
              timeAfterCreate = "string"
              timeBeforeExpiry = "string"
            }
          }
        ]
      }
    }
  })
}

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

managedHSMs/keys

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.KeyVault/managedHSMs/keys@2022-11-01"
name	имя ресурса.	строка (обязательно)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: managedHSM
tags	Теги, которые будут назначены ключу.	Словарь имен и значений тегов.
properties	Свойства создаваемого ключа.	ManagedHsmKeyProperties (обязательно)

ManagedHsmKeyProperties

Имя	Описание	Значение
attributes	Атрибуты ключа.	ManagedHsmKeyAttributes
curveName	Имя эллиптической кривой. Допустимые значения см. в разделе JsonWebKeyCurveName.	"P-256" "P-256K" "P-384" "P-521"
keyOps		Массив строк, содержащий любой из: "расшифровка" "encrypt" "import" "release" "sign" unwrapKey "verify" "wrapKey"
keySize	Размер ключа в битах. Например: 2048, 3072 или 4096 для RSA.	INT
kty	Тип ключа. Допустимые значения см. в разделе JsonWebKeyType.	"EC" "EC-HSM" "RSA" "RSA-HSM"
release_policy	Политика выпуска ключа в ответ. Он будет использоваться как для вывода, так и для входных данных. Опущен, если он пуст	ManagedHsmKeyReleasePolicy
rotationPolicy	Политика смены ключей в ответ. Он будет использоваться как для вывода, так и для входных данных. Опущен, если он пуст	ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

Имя	Описание	Значение
Включено	Определяет, включен ли объект.	bool
exp	Дата окончания срока действия в секундах с 1970-01-01T00:00:00Z.	INT
Экспортируемый	Указывает, можно ли экспортировать закрытый ключ.	bool
nbf	Не раньше даты в секундах с 1970-01-01T00:00:00Z.	INT

ManagedHsmKeyReleasePolicy

Имя	Описание	Значение
сontentType	Тип контента и версия политики выпуска ключа	строка
.	Кодирование BLOB-объектов правил политики, в соответствии с которыми можно освободить ключ.	строка

ManagedHsmRotationPolicy

Имя	Описание	Значение
attributes	Атрибуты политики смены ключей.	ManagedHsmKeyRotationPolicyAttributes
lifetimeActions	Действие lifetimeActions для действия смены ключей.	ManagedHsmLifetimeAction[]

ManagedHsmKeyRotationPolicyAttributes

Имя	Описание	Значение
expiryTime	Срок действия новой версии ключа. Он должен быть в ISO8601 формате. Например: "P90D", "P1Y".	строка

ManagedHsmLifetimeAction

Имя	Описание	Значение
action	Действие жизненного цикла политики смены ключей.	ManagedHsmAction
триггер	Триггер жизненного цикла политики смены ключей.	ManagedHsmTrigger

ManagedHsmAction

Имя	Описание	Значение
тип	Тип действия. Значение должно сравниваться без учета регистра.	"Уведомлять" "Повернуть"

ManagedHsmTrigger

Имя	Описание	Значение
timeAfterCreate	Длительность смены ключа после создания ключа. Он применяется только для поворота. Он будет иметь формат длительности ISO 8601. Например: "P90D", "P1Y".	строка
TimeBeforeExpiry	Время до истечения срока действия ключа для смены или уведомления. Он будет иметь формат длительности ISO 8601. Например: "P90D", "P1Y".	строка

Share via

Microsoft.KeyVault managedHSMs/keys 2022-11-01

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

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

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

managedHSMs/keys

ManagedHsmKeyProperties

ManagedHsmKeyAttributes

ManagedHsmKeyReleasePolicy

ManagedHsmRotationPolicy

ManagedHsmKeyRotationPolicyAttributes

ManagedHsmLifetimeAction

ManagedHsmAction

ManagedHsmTrigger

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

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

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

managedHSMs/keys

ManagedHsmKeyProperties

ManagedHsmKeyAttributes

ManagedHsmKeyReleasePolicy

ManagedHsmRotationPolicy

ManagedHsmKeyRotationPolicyAttributes

ManagedHsmLifetimeAction

ManagedHsmAction

ManagedHsmTrigger

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

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

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

managedHSMs/keys

ManagedHsmKeyProperties

ManagedHsmKeyAttributes

ManagedHsmKeyReleasePolicy

ManagedHsmRotationPolicy

ManagedHsmKeyRotationPolicyAttributes

ManagedHsmLifetimeAction

ManagedHsmAction

ManagedHsmTrigger

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

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

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