Microsoft.ApiManagement service/namedValues 2023-05-01-preview
Определение ресурса Bicep
Тип ресурса service/namedValues можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.ApiManagement/service/namedValues, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Значения свойств
service/namedValues
| Имя | Описание | Значение |
|---|---|---|
| name | имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep. |
строка (обязательно) |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: service |
| properties | Свойства контракта сущности NamedValue для операции PUT. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Имя | Описание | Значение |
|---|---|---|
| displayName | Уникальное имя NamedValue. Может содержать только буквы, цифры, точки, тире и знаки подчеркивания. | строка (обязательно) |
| keyVault | Сведения о расположении хранилища ключей для объекта namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Определяет, является ли значение секретом и должно ли быть зашифровано. Значение по умолчанию — false. | bool |
| tags | Необязательные теги, которые при указании можно использовать для фильтрации списка NamedValue. | string[] |
| значение | Значение NamedValue. Может содержать выражения политики. Не может быть пустым или состоять только из пробелов. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение. | строка |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Имя | Описание | Значение |
|---|---|---|
| identityClientId | Значение NULL для SystemAssignedIdentity или идентификатор клиента для UserAssignedIdentity, который будет использоваться для доступа к секрету хранилища ключей. | строка |
| secretIdentifier | Идентификатор секрета хранилища ключей для получения секрета. Предоставление секрета с управлением версиями помешает автоматическому обновлению. Для этого необходимо, чтобы служба Управление API была настроена с помощью aka.ms/apimmsi | строка |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
Front Door уровня "Стандартный" или "Премиум" с источником Управление API |
Этот шаблон создает Front Door Premium и экземпляр Управление API, а также использует NSG и глобальную политику Управление API для проверки того, что трафик проходит через источник Front Door. |
Определение ресурса шаблона ARM
Тип ресурса service/namedValues можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.ApiManagement/service/namedValues, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Значения свойств
service/namedValues
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | Microsoft.ApiManagement/service/namedValues |
| версия_API | Версия API ресурсов | '2023-05-01-preview' |
| name | имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM. |
строка (обязательно) |
| properties | Свойства контракта сущности NamedValue для операции PUT. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Имя | Описание | Значение |
|---|---|---|
| displayName | Уникальное имя NamedValue. Может содержать только буквы, цифры, точки, тире и знаки подчеркивания. | строка (обязательно) |
| keyVault | Сведения о расположении хранилища ключей для объекта namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Определяет, является ли значение секретом и должно ли быть зашифровано. Значение по умолчанию — false. | bool |
| tags | Необязательные теги, которые при указании можно использовать для фильтрации списка NamedValue. | string[] |
| значение | Значение NamedValue. Может содержать выражения политики. Не может быть пустым или состоять только из пробелов. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение. | строка |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Имя | Описание | Значение |
|---|---|---|
| identityClientId | Значение NULL для SystemAssignedIdentity или идентификатор клиента для UserAssignedIdentity, который будет использоваться для доступа к секрету хранилища ключей. | строка |
| secretIdentifier | Идентификатор секрета хранилища ключей для получения секрета. Предоставление секрета с управлением версиями помешает автоматическому обновлению. Для этого необходимо, чтобы служба Управление API была настроена с помощью aka.ms/apimmsi | строка |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
| Front Door уровня "Стандартный" или "Премиум" с источником Управление API |
Этот шаблон создает Front Door Premium и экземпляр Управление API, а также использует NSG и глобальную политику Управление API для проверки того, что трафик проходит через источник Front Door. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса service/namedValues можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.ApiManagement/service/namedValues, добавьте в шаблон следующую terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2023-05-01-preview"
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@2023-05-01-preview |
| name | имя ресурса. | строка (обязательно) |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: service |
| properties | Свойства контракта сущности NamedValue для операции PUT. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Имя | Описание | Значение |
|---|---|---|
| displayName | Уникальное имя NamedValue. Может содержать только буквы, цифры, точки, тире и знаки подчеркивания. | строка (обязательно) |
| keyVault | Сведения о расположении хранилища ключей для объекта namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Определяет, является ли значение секретом и должно ли быть зашифровано. Значение по умолчанию — false. | bool |
| tags | Необязательные теги, которые при указании можно использовать для фильтрации списка NamedValue. | string[] |
| значение | Значение NamedValue. Может содержать выражения политики. Не может быть пустым или состоять только из пробелов. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение. | строка |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Имя | Описание | Значение |
|---|---|---|
| identityClientId | Значение NULL для SystemAssignedIdentity или идентификатор клиента для UserAssignedIdentity , который будет использоваться для доступа к секрету хранилища ключей. | строка |
| secretIdentifier | Идентификатор секрета хранилища ключей для получения секрета. Предоставление секрета с управлением версиями помешает автоматическому обновлению. Для этого требуется, чтобы служба Управление API была настроена с помощью aka.ms/apimmsi | строка |