Microsoft.KeyVault vaults/keys 2021-04-01-preview

  • Статья

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

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

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

Комментарии

Рекомендации по использованию хранилищ ключей для безопасных значений см. в статье Управление секретами с помощью Bicep.

Краткое руководство по созданию секрета см. в статье Краткое руководство. Установка и извлечение секрета из Azure Key Vault с помощью шаблона ARM.

Краткое руководство по созданию ключа см. в статье Краткое руководство. Создание хранилища ключей Azure и ключа с помощью шаблона ARM.

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

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

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

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

хранилища и ключи

Имя Описание Значение
name имя ресурса.

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

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: vaults
properties Свойства создаваемого ключа. KeyProperties (обязательно)

KeyProperties

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

KeyAttributes

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

RotationPolicy

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

KeyRotationPolicyAttributes

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

LifetimeAction

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

Действие

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

Триггер

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

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

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

Шаблон Описание
Создание ключа в Хранилище ключей Azure

Развертывание в Azure		 Этот модуль позволяет создать ключ в существующем Хранилище ключей.
Шифрование учетной записи хранения Azure с помощью ключа, управляемого клиентом

Развертывание в Azure		 Этот шаблон развертывает учетную запись хранения с ключом, управляемым клиентом, для шифрования, который создается и помещается в Key Vault.

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

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

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

Комментарии

Рекомендации по использованию хранилищ ключей для безопасных значений см. в статье Управление секретами с помощью Bicep.

Краткое руководство по созданию секрета см. в статье Краткое руководство. Установка и извлечение секрета из Azure Key Vault с помощью шаблона ARM.

Краткое руководство по созданию ключа см. в статье Краткое руководство. Создание хранилища ключей Azure и ключа с помощью шаблона ARM.

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

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

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "nbf": "int"
    },
    "curveName": "string",
    "keyOps": [ "string" ],
    "keySize": "int",
    "kty": "string",
    "rotationPolicy": {
      "attributes": {
        "expiryTime": "string"
      },
      "lifetimeActions": [
        {
          "action": {
            "type": "string"
          },
          "trigger": {
            "timeAfterCreate": "string",
            "timeBeforeExpiry": "string"
          }
        }
      ]
    }
  }
}

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

хранилища и ключи

Имя Описание Значение
тип Тип ресурса Microsoft.KeyVault/vaults/keys
версия_API Версия API ресурсов '2021-04-01-preview'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.		 строка (обязательно)
tags Теги, которые будут назначены ключу. Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties Свойства создаваемого ключа. KeyProperties (обязательно)

KeyProperties

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

KeyAttributes

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

RotationPolicy

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

KeyRotationPolicyAttributes

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

LifetimeAction

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

Действие

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

Триггер

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

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

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

Шаблон Описание
Создание ключа в Хранилище ключей Azure

Развертывание в Azure		 Этот модуль позволяет создать ключ в существующем Хранилище ключей.
Шифрование учетной записи хранения Azure с помощью ключа, управляемого клиентом

Развертывание в Azure		 Этот шаблон развертывает учетную запись хранения с ключом, управляемым клиентом, для шифрования, который создается и помещается в Key Vault.

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

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

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

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

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

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

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

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

хранилища и ключи

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

KeyProperties

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

KeyAttributes

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

RotationPolicy

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

KeyRotationPolicyAttributes

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

LifetimeAction

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

Действие

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

Триггер

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