Microsoft.KeyVault vaults/keys 2021-10-01
Определение ресурса Bicep
Тип ресурса vaults/keys можно развернуть в следующих объектах:
- Группы ресурсов — см. команды развертывания групп ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Комментарии
Рекомендации по использованию хранилищ ключей для безопасных значений см. в статье Управление секретами с помощью Bicep.
Краткое руководство по созданию секрета см. в статье Краткое руководство. Установка и получение секрета из Azure Key Vault с помощью шаблона ARM.
Краткое руководство по созданию ключа см. в статье Краткое руководство. Создание хранилища ключей Azure и ключа с помощью шаблона ARM.
Формат ресурсов
Чтобы создать ресурс Microsoft.KeyVault/vaults/keys, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.KeyVault/vaults/keys@2021-10-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'
}
}
Значения свойств
хранилища и ключи
| Имя | Описание | Значение |
|---|---|---|
| name | имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep. |
string (обязательно) |
| tags | Теги, которые будут назначены ключу. | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа : хранилища |
| 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" |
KeyAttributes
| Имя | Описание | Значение |
|---|---|---|
| Включено | Определяет, включен ли объект . | bool |
| exp | Дата истечения срока действия в секундах с 1970-01-01T00:00:00Z. | INT |
| Экспортируемый | Указывает, можно ли экспортировать закрытый ключ. | bool |
| nbf | Не раньше даты в секундах с 1970-01-01T00:00:00Z. | INT |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
Создание ключа в Хранилище ключей 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-10-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"
}
}
Значения свойств
хранилища и ключи
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | Microsoft.KeyVault/vaults/keys |
| версия_API | Версия API ресурсов | '2021-10-01' |
| name | имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM. |
string (обязательно) |
| 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" |
KeyAttributes
| Имя | Описание | Значение |
|---|---|---|
| Включено | Определяет, включен ли объект . | bool |
| exp | Дата истечения срока действия в секундах с 1970-01-01T00:00:00Z. | INT |
| Экспортируемый | Указывает, можно ли экспортировать закрытый ключ. | bool |
| nbf | Не раньше даты в секундах с 1970-01-01T00:00:00Z. | INT |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
| Создание ключа в Хранилище ключей Azure |
Этот модуль позволяет создать ключ в существующем хранилище ключей. |
| Шифрование учетной записи хранения Azure с помощью ключа, управляемого клиентом |
Этот шаблон развертывает учетную запись хранения с ключом, управляемым клиентом, для шифрования, который создается и помещается в Key Vault. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса vaults/keys можно развернуть в следующих объектах:
- Группы ресурсов
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.KeyVault/vaults/keys, добавьте следующую terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/vaults/keys@2021-10-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"
}
})
}
Значения свойств
хранилища и ключи
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | "Microsoft.KeyVault/vaults/keys@2021-10-01" |
| name | имя ресурса. | string (обязательно) |
| 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" |
KeyAttributes
| Имя | Описание | Значение |
|---|---|---|
| Включено | Определяет, включен ли объект . | bool |
| exp | Дата истечения срока действия в секундах с 1970-01-01T00:00:00Z. | INT |
| Экспортируемый | Указывает, можно ли экспортировать закрытый ключ. | bool |
| nbf | Не раньше даты в секундах с 1970-01-01T00:00:00Z. | INT |
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе: https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по