Шлюзы Microsoft.ApiManagement 2023-09-01-preview
- последние
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
Определение ресурсов Bicep
Тип ресурсов шлюзов можно развернуть с помощью операций, предназначенных для следующих целей:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/gateways, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/gateways@2023-09-01-preview' = {
location: 'string'
name: 'string'
properties: {
backend: {
subnet: {
id: 'string'
}
}
configurationApi: {}
frontend: {}
virtualNetworkType: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Значения свойств
ApiManagementGatewayProperties
| Имя | Описание | Ценность |
|---|---|---|
| серверная часть | Сведения о том, как шлюз должен интегрироваться с внутренними системами. | BackendConfiguration |
| configurationApi | Сведения об API конфигурации шлюза управления API. Это применимо только для шлюза API со стандартным номером SKU. | GatewayConfigurationApi |
| интерфейсный интерфейс | Сведения о том, как должен предоставляться шлюз. | FrontendConfiguration |
| virtualNetworkType | Тип VPN, в котором необходимо настроить шлюз управления API. | "Внешний" "Внутренний" "Нет" |
ApiManagementGatewaySkuProperties
| Имя | Описание | Ценность |
|---|---|---|
| способность | Емкость номера SKU (количество развернутых единиц SKU) | int |
| имя | Имя SKU. | "Стандартный" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (обязательно) |
ApimResourceTags
| Имя | Описание | Ценность |
|---|
BackendConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| подсеть | Имя узла по умолчанию шлюза плоскости данных, в который можно отправлять запросы. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| идентификатор | Идентификатор ARM подсети, в которой размещаются серверные системы. | струна |
FrontendConfiguration
| Имя | Описание | Ценность |
|---|
GatewayConfigurationApi
| Имя | Описание | Ценность |
|---|
Microsoft.ApiManagement/gateways
| Имя | Описание | Ценность |
|---|---|---|
| местоположение | Расположение ресурса. | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 45 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (обязательно) |
| свойства | Свойства шлюза управления API. | ApiManagementGatewayProperties (обязательно) |
| SKU | Свойства SKU шлюза управления API. | ApiManagementGatewaySkuProperties (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
Определение ресурса шаблона ARM
Тип ресурсов шлюзов можно развернуть с помощью операций, предназначенных для следующих целей:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/gateways, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/gateways",
"apiVersion": "2023-09-01-preview",
"name": "string",
"location": "string",
"properties": {
"backend": {
"subnet": {
"id": "string"
}
},
"configurationApi": {
},
"frontend": {
},
"virtualNetworkType": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Значения свойств
ApiManagementGatewayProperties
| Имя | Описание | Ценность |
|---|---|---|
| серверная часть | Сведения о том, как шлюз должен интегрироваться с внутренними системами. | BackendConfiguration |
| configurationApi | Сведения об API конфигурации шлюза управления API. Это применимо только для шлюза API со стандартным номером SKU. | GatewayConfigurationApi |
| интерфейсный интерфейс | Сведения о том, как должен предоставляться шлюз. | FrontendConfiguration |
| virtualNetworkType | Тип VPN, в котором необходимо настроить шлюз управления API. | "Внешний" "Внутренний" "Нет" |
ApiManagementGatewaySkuProperties
| Имя | Описание | Ценность |
|---|---|---|
| способность | Емкость номера SKU (количество развернутых единиц SKU) | int |
| имя | Имя SKU. | "Стандартный" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (обязательно) |
ApimResourceTags
| Имя | Описание | Ценность |
|---|
BackendConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| подсеть | Имя узла по умолчанию шлюза плоскости данных, в который можно отправлять запросы. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| идентификатор | Идентификатор ARM подсети, в которой размещаются серверные системы. | струна |
FrontendConfiguration
| Имя | Описание | Ценность |
|---|
GatewayConfigurationApi
| Имя | Описание | Ценность |
|---|
Microsoft.ApiManagement/gateways
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2023-09-01-preview' |
| местоположение | Расположение ресурса. | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 45 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (обязательно) |
| свойства | Свойства шлюза управления API. | ApiManagementGatewayProperties (обязательно) |
| SKU | Свойства SKU шлюза управления API. | ApiManagementGatewaySkuProperties (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
| тип | Тип ресурса | "Microsoft.ApiManagement/gateways" |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурсов шлюзов можно развернуть с помощью операций, предназначенных для следующих целей:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/gateways, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/gateways@2023-09-01-preview"
name = "string"
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
backend = {
subnet = {
id = "string"
}
}
configurationApi = {
}
frontend = {
}
virtualNetworkType = "string"
}
})
}
Значения свойств
ApiManagementGatewayProperties
| Имя | Описание | Ценность |
|---|---|---|
| серверная часть | Сведения о том, как шлюз должен интегрироваться с внутренними системами. | BackendConfiguration |
| configurationApi | Сведения об API конфигурации шлюза управления API. Это применимо только для шлюза API со стандартным номером SKU. | GatewayConfigurationApi |
| интерфейсный интерфейс | Сведения о том, как должен предоставляться шлюз. | FrontendConfiguration |
| virtualNetworkType | Тип VPN, в котором необходимо настроить шлюз управления API. | "Внешний" "Внутренний" "Нет" |
ApiManagementGatewaySkuProperties
| Имя | Описание | Ценность |
|---|---|---|
| способность | Емкость номера SKU (количество развернутых единиц SKU) | int |
| имя | Имя SKU. | "Стандартный" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (обязательно) |
ApimResourceTags
| Имя | Описание | Ценность |
|---|
BackendConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| подсеть | Имя узла по умолчанию шлюза плоскости данных, в который можно отправлять запросы. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| идентификатор | Идентификатор ARM подсети, в которой размещаются серверные системы. | струна |
FrontendConfiguration
| Имя | Описание | Ценность |
|---|
GatewayConfigurationApi
| Имя | Описание | Ценность |
|---|
Microsoft.ApiManagement/gateways
| Имя | Описание | Ценность |
|---|---|---|
| местоположение | Расположение ресурса. | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 45 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (обязательно) |
| свойства | Свойства шлюза управления API. | ApiManagementGatewayProperties (обязательно) |
| SKU | Свойства SKU шлюза управления API. | ApiManagementGatewaySkuProperties (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. |
| тип | Тип ресурса | "Microsoft.ApiManagement/gateways@2023-09-01-preview" |