Служба Microsoft.ApiManagement/namedValues 2022-08-01
- последние
- 2023-09-01-preview
- 2022-08-01
- 2021-08-01
Определение ресурсов Bicep
Тип ресурса service/namedValues можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/namedValues, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2022-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Значения свойств
service/namedValues
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в Bicep. |
строка (обязательно) |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: служба |
| свойства | Свойства контракта сущности NamedValue для операции PUT. | NameValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Имя | Описание | Ценность |
|---|---|---|
| displayName | Уникальное имя NamedValue. Он может содержать только буквы, цифры, точки, дефисы и символы подчеркивания. | строка (обязательно) Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 Pattern = ^[A-Za-z0-9-._]+$ |
| keyVault | Сведения о расположении KeyVault для именованного значения. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| секрет | Определяет, является ли значение секретом и должно быть зашифровано или нет. Значение по умолчанию — false. | bool |
| Теги | Необязательные теги, которые можно использовать для фильтрации списка NamedValue. | string[] Ограничения целостности: Максимальная длина = 32 |
| ценность | Значение Именованного значения. Может содержать выражения политики. Она может быть не пустой или состоять только из пробелов. Это свойство не будет заполнено в операциях GET! Используйте запрос POST "/listSecrets", чтобы получить это значение. | струна Ограничения целостности: Максимальная длина = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Имя | Описание | Ценность |
|---|---|---|
| identityClientId | Null для SystemAssignedIdentity или идентификатор клиента для UserAssignedIdentity, который будет использоваться для доступа к секрету хранилища ключей. | струна |
| secretIdentifier | Идентификатор секрета хранилища ключей для получения секрета. Предоставление секрета с версиями будет препятствовать автоматическому обновлению. Для этого требуется, чтобы служба управления API была настроена с помощью aka.ms/apimmsi | струна |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
|
Front Door Standard/Premium с источником управления API развертывание  |
Этот шаблон создает front Door Premium и экземпляр службы управления API, а также использует группу безопасности сети и глобальную политику управления API для проверки того, что трафик прошел через источник Front Door. |
Определение ресурса шаблона ARM
Тип ресурса service/namedValues можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/namedValues, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2022-08-01",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Значения свойств
service/namedValues
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ApiManagement/service/namedValues" |
| apiVersion | Версия API ресурсов | '2022-08-01' |
| имя | Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON. |
строка (обязательно) |
| свойства | Свойства контракта сущности NamedValue для операции PUT. | NameValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Имя | Описание | Ценность |
|---|---|---|
| displayName | Уникальное имя NamedValue. Он может содержать только буквы, цифры, точки, дефисы и символы подчеркивания. | строка (обязательно) Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 Pattern = ^[A-Za-z0-9-._]+$ |
| keyVault | Сведения о расположении KeyVault для именованного значения. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| секрет | Определяет, является ли значение секретом и должно быть зашифровано или нет. Значение по умолчанию — false. | bool |
| Теги | Необязательные теги, которые можно использовать для фильтрации списка NamedValue. | string[] Ограничения целостности: Максимальная длина = 32 |
| ценность | Значение Именованного значения. Может содержать выражения политики. Она может быть не пустой или состоять только из пробелов. Это свойство не будет заполнено в операциях GET! Используйте запрос POST "/listSecrets", чтобы получить это значение. | струна Ограничения целостности: Максимальная длина = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Имя | Описание | Ценность |
|---|---|---|
| identityClientId | Null для SystemAssignedIdentity или идентификатор клиента для UserAssignedIdentity, который будет использоваться для доступа к секрету хранилища ключей. | струна |
| secretIdentifier | Идентификатор секрета хранилища ключей для получения секрета. Предоставление секрета с версиями будет препятствовать автоматическому обновлению. Для этого требуется, чтобы служба управления API была настроена с помощью aka.ms/apimmsi | струна |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
|
Front Door Standard/Premium с источником управления API развертывание |
Этот шаблон создает front Door Premium и экземпляр службы управления API, а также использует группу безопасности сети и глобальную политику управления API для проверки того, что трафик прошел через источник Front Door. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса service/namedValues можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/namedValues, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2022-08-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Значения свойств
service/namedValues
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ApiManagement/service/namedValues@2022-08-01" |
| имя | Имя ресурса | строка (обязательно) |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: службы |
| свойства | Свойства контракта сущности NamedValue для операции PUT. | NameValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Имя | Описание | Ценность |
|---|---|---|
| displayName | Уникальное имя NamedValue. Он может содержать только буквы, цифры, точки, дефисы и символы подчеркивания. | строка (обязательно) Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 Pattern = ^[A-Za-z0-9-._]+$ |
| keyVault | Сведения о расположении KeyVault для именованного значения. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| секрет | Определяет, является ли значение секретом и должно быть зашифровано или нет. Значение по умолчанию — false. | bool |
| Теги | Необязательные теги, которые можно использовать для фильтрации списка NamedValue. | string[] Ограничения целостности: Максимальная длина = 32 |
| ценность | Значение Именованного значения. Может содержать выражения политики. Она может быть не пустой или состоять только из пробелов. Это свойство не будет заполнено в операциях GET! Используйте запрос POST "/listSecrets", чтобы получить это значение. | струна Ограничения целостности: Максимальная длина = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Имя | Описание | Ценность |
|---|---|---|
| identityClientId | Null для SystemAssignedIdentity или идентификатор клиента для UserAssignedIdentity, который будет использоваться для доступа к секрету хранилища ключей. | струна |
| secretIdentifier | Идентификатор секрета хранилища ключей для получения секрета. Предоставление секрета с версиями будет препятствовать автоматическому обновлению. Для этого требуется, чтобы служба управления API была настроена с помощью aka.ms/apimmsi | струна |