Хранилища Microsoft.KeyVault и секреты 2016-10-01
Замечания
Рекомендации по использованию хранилищ ключей для безопасных значений см. в статье Управление секретами с помощью Bicep.
Краткое руководство по созданию секрета см. в кратком руководстве по . Настройка и извлечение секрета из Azure Key Vault с помощьюшаблона ARM.
Краткое руководство по созданию ключа см. в кратком руководстве по . Создание хранилища ключей Azure и ключа с помощью шаблона ARM.
Определение ресурсов Bicep
Тип ресурса хранилища и секретов можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.KeyVault/vaults/secret, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.KeyVault/vaults/secrets@2016-10-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
attributes: {
enabled: bool
exp: int
nbf: int
}
contentType: 'string'
value: 'string'
}
tags: {
{customized property}: 'string'
}
}
Значения свойств
Microsoft.KeyVault/vaults/secret
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Pattern = ^[a-zA-Z0-9-]{1,127}$ (обязательно) |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: хранилища |
| свойства | Свойства секрета | SecretProperties (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
SecretAttributes
| Имя | Описание | Ценность |
|---|---|---|
| Включен | Определяет, включен ли объект. | bool |
| exp | Дата окончания срока действия в секундах с 1970-01-01T00:00:00Z. | int |
| nbf | Не до даты в секундах с 1970-01-01T00:00:00Z. | int |
SecretCreateOrUpdateParametersTags
| Имя | Описание | Ценность |
|---|
SecretProperties
| Имя | Описание | Ценность |
|---|---|---|
| Атрибуты | Атрибуты секрета. | SecretAttributes |
| contentType | Тип контента секрета. | струна |
| ценность | Значение секрета. ПРИМЕЧАНИЕ. Значение никогда не будет возвращено из службы, так как API-интерфейсы, использующие эту модель, предназначены для внутреннего использования в развертываниях ARM. Пользователи должны использовать службу REST плоскости данных для взаимодействия с секретами хранилища. | струна |
Примеры краткого руководства
Следующие примеры краткого руководства по развертыванию этого типа ресурса.
| Bicep-файл | Описание |
|---|---|
| Шлюз приложений с внутренним управлением API и веб-приложения | Шлюз приложений маршрутизации трафика Интернета в экземпляр управления API виртуальной сети (внутренний режим), который обслуживает веб-API, размещенный в веб-приложении Azure. |
| приложение-функцию Azure и функцию, активированную ПО HTTP, | Этот пример развертывает приложение-функцию Azure и встроенную функцию, активированную ПО HTTP, в шаблоне. Он также развертывает Key Vault и заполняет секрет ключом узла приложения-функции. |
| создание Хранилища ключей и списка секретов | Этот шаблон создает Key Vault и список секретов в хранилище ключей, как передано вместе с параметрами. |
| Создание службы управления API с помощью SSL из KeyVault | Этот шаблон развертывает службу управления API, настроенную с удостоверением, назначенным пользователем. Он использует это удостоверение для получения SSL-сертификата из KeyVault и сохраняет его обновление, проверяя каждые 4 часа. |
| Создание Azure Key Vault и секрета | Этот шаблон создает Azure Key Vault и секрет. |
| создание Azure Key Vault с помощью RBAC и секрета | Этот шаблон создает Azure Key Vault и секрет. Вместо того чтобы полагаться на политики доступа, она использует Azure RBAC для управления авторизацией в секретах |
| концентратора FinOps |
Этот шаблон создает новый экземпляр концентратора FinOps, включая хранилище Data Lake и фабрику данных. |
| среда тестирования для брандмауэра Azure Premium | Этот шаблон создает политику брандмауэра Azure premium и брандмауэра с такими функциями, как обнаружение вторжений (IDPS), проверка TLS и фильтрация веб-категорий |
Определение ресурса шаблона ARM
Тип ресурса хранилища и секретов можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.KeyVault/vaults/secret, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.KeyVault/vaults/secrets",
"apiVersion": "2016-10-01",
"name": "string",
"properties": {
"attributes": {
"enabled": "bool",
"exp": "int",
"nbf": "int"
},
"contentType": "string",
"value": "string"
},
"tags": {
"{customized property}": "string"
}
}
Значения свойств
Microsoft.KeyVault/vaults/secret
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2016-10-01' |
| имя | Имя ресурса | струна Ограничения целостности: Pattern = ^[a-zA-Z0-9-]{1,127}$ (обязательно) |
| свойства | Свойства секрета | SecretProperties (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
| тип | Тип ресурса | "Microsoft.KeyVault/vaults/secret" |
SecretAttributes
| Имя | Описание | Ценность |
|---|---|---|
| Включен | Определяет, включен ли объект. | bool |
| exp | Дата окончания срока действия в секундах с 1970-01-01T00:00:00Z. | int |
| nbf | Не до даты в секундах с 1970-01-01T00:00:00Z. | int |
SecretCreateOrUpdateParametersTags
| Имя | Описание | Ценность |
|---|
SecretProperties
| Имя | Описание | Ценность |
|---|---|---|
| Атрибуты | Атрибуты секрета. | SecretAttributes |
| contentType | Тип контента секрета. | струна |
| ценность | Значение секрета. ПРИМЕЧАНИЕ. Значение никогда не будет возвращено из службы, так как API-интерфейсы, использующие эту модель, предназначены для внутреннего использования в развертываниях ARM. Пользователи должны использовать службу REST плоскости данных для взаимодействия с секретами хранилища. | струна |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
|
Шлюз приложений с внутренним управлением API и веб-приложения развертывание  |
Шлюз приложений маршрутизации трафика Интернета в экземпляр управления API виртуальной сети (внутренний режим), который обслуживает веб-API, размещенный в веб-приложении Azure. |
|
приложение-функцию Azure и функцию, активированную ПО HTTP, развертывание |
Этот пример развертывает приложение-функцию Azure и встроенную функцию, активированную ПО HTTP, в шаблоне. Он также развертывает Key Vault и заполняет секрет ключом узла приложения-функции. |
|
Подключение к Key Vault через частную конечную точку развертывание |
В этом примере показано, как настроить виртуальную сеть и частную зону DNS для доступа к Key Vault через частную конечную точку. |
|
создание Хранилища ключей и списка секретов развертывание |
Этот шаблон создает Key Vault и список секретов в хранилище ключей, как передано вместе с параметрами. |
|
Создание службы управления API с помощью SSL из KeyVault развертывание |
Этот шаблон развертывает службу управления API, настроенную с удостоверением, назначенным пользователем. Он использует это удостоверение для получения SSL-сертификата из KeyVault и сохраняет его обновление, проверяя каждые 4 часа. |
|
Создание шлюза приложений версии 2 с помощью key Vault развертывание |
Этот шаблон развертывает шлюз приложений версии 2 в виртуальной сети, определяемое пользователем удостоверение, Key Vault, секрет (данные сертификата) и политику доступа в Key Vault и шлюзе приложений. |
|
Создание Azure Key Vault и секрета развертывание |
Этот шаблон создает Azure Key Vault и секрет. |
|
создание Azure Key Vault с помощью RBAC и секрета развертывание |
Этот шаблон создает Azure Key Vault и секрет. Вместо того чтобы полагаться на политики доступа, она использует Azure RBAC для управления авторизацией в секретах |
|
Создание маркера SAS Azure Maps, хранящегося в Azure Key Vault развертывание |
Этот шаблон развертывает учетную запись Azure Maps и перечисляет маркер SAS на основе предоставленного удостоверения, назначенного пользователем, который будет храниться в секрете Azure Key Vault. |
|
Создание ключей ssh и хранение в KeyVault развертывание |
Этот шаблон использует ресурс deploymentScript для создания ключей SSH и хранения закрытого ключа в keyVault. |
|
создает кластер Azure Stack HCI 23H2 развертывание |
Этот шаблон создает кластер Azure Stack HCI 23H2 с помощью шаблона ARM с помощью пользовательского IP-адреса хранилища. |
|
создает кластер Azure Stack HCI 23H2 развертывание |
Этот шаблон создает кластер Azure Stack HCI 23H2 с помощью шаблона ARM. |
|
создает кластер Azure Stack HCI 23H2 в режиме сети без переключения с двумя ссылками развертывание |
Этот шаблон создает кластер Azure Stack HCI 23H2 с помощью шаблона ARM. |
|
создает кластер Azure Stack HCI 23H2 в Switchless-SingleLink сетевом режиме развертывание |
Этот шаблон создает кластер Azure Stack HCI 23H2 с помощью шаблона ARM. |
| концентратора FinOps развертывание |
Этот шаблон создает новый экземпляр концентратора FinOps, включая хранилище Data Lake и фабрику данных. |
| среда тестирования для брандмауэра Azure Premium развертывание |
Этот шаблон создает политику брандмауэра Azure premium и брандмауэра с такими функциями, как обнаружение вторжений (IDPS), проверка TLS и фильтрация веб-категорий |
|
обновляет кластер Azure Stack HCI 22H2 до кластера 23H2 развертывание |
Этот шаблон обновляет кластер Azure Stack HCI 22H2 до кластера 23H2 с помощью шаблона ARM. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса хранилища и секретов можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.KeyVault/vaults/secret, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/vaults/secrets@2016-10-01"
name = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
attributes = {
enabled = bool
exp = int
nbf = int
}
contentType = "string"
value = "string"
}
})
}
Значения свойств
Microsoft.KeyVault/vaults/secret
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Pattern = ^[a-zA-Z0-9-]{1,127}$ (обязательно) |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: хранилища |
| свойства | Свойства секрета | SecretProperties (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. |
| тип | Тип ресурса | "Microsoft.KeyVault/vaults/secrets@2016-10-01" |
SecretAttributes
| Имя | Описание | Ценность |
|---|---|---|
| Включен | Определяет, включен ли объект. | bool |
| exp | Дата окончания срока действия в секундах с 1970-01-01T00:00:00Z. | int |
| nbf | Не до даты в секундах с 1970-01-01T00:00:00Z. | int |
SecretCreateOrUpdateParametersTags
| Имя | Описание | Ценность |
|---|
SecretProperties
| Имя | Описание | Ценность |
|---|---|---|
| Атрибуты | Атрибуты секрета. | SecretAttributes |
| contentType | Тип контента секрета. | струна |
| ценность | Значение секрета. ПРИМЕЧАНИЕ. Значение никогда не будет возвращено из службы, так как API-интерфейсы, использующие эту модель, предназначены для внутреннего использования в развертываниях ARM. Пользователи должны использовать службу REST плоскости данных для взаимодействия с секретами хранилища. | струна |