Шлюзы Microsoft.ApiManagement 2023-09-01-preview
- последние
- 2023-09-01-preview
Определение ресурсов Bicep
Тип ресурсов шлюзов можно развернуть с помощью операций, предназначенных для следующих целей:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/gateways, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/gateways@2023-09-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
}
properties: {
backend: {
subnet: {
id: 'string'
}
}
configurationApi: {}
frontend: {}
virtualNetworkType: 'string'
}
}
Значения свойств
Шлюзы
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | строка (обязательно) |
| местоположение | Расположение ресурса. | строка (обязательно) |
| Теги | Теги ресурсов. | Словарь имен и значений тегов. См. теги в шаблонах |
| SKU | Свойства SKU шлюза управления API. | ApiManagementGatewaySkuProperties (обязательно) |
| свойства | Свойства шлюза управления API. | ApiManagementGatewayProperties (обязательно) |
ApiManagementGatewayProperties
| Имя | Описание | Ценность |
|---|---|---|
| серверная часть | Сведения о том, как шлюз должен интегрироваться с внутренними системами. | BackendConfiguration |
| configurationApi | Сведения об API конфигурации шлюза управления API. Это применимо только для шлюза API со стандартным номером SKU. | GatewayConfigurationApi |
| интерфейсный интерфейс | Сведения о том, как должен предоставляться шлюз. | FrontendConfiguration |
| virtualNetworkType | Тип VPN, в котором необходимо настроить шлюз управления API. | "Внешний" "Внутренний" "Нет" |
BackendConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| подсеть | Имя узла по умолчанию шлюза плоскости данных, в который можно отправлять запросы. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| идентификатор | Идентификатор ARM подсети, в которой размещаются серверные системы. | струна |
GatewayConfigurationApi
Этот объект не содержит свойств, заданных во время развертывания. Все свойства — ReadOnly.
FrontendConfiguration
Этот объект не содержит свойств, заданных во время развертывания. Все свойства — ReadOnly.
ApiManagementGatewaySkuProperties
| Имя | Описание | Ценность |
|---|---|---|
| способность | Емкость номера SKU (количество развернутых единиц SKU) | int |
| имя | Имя SKU. | "Стандартный" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (обязательно) |
Определение ресурса шаблона ARM
Тип ресурсов шлюзов можно развернуть с помощью операций, предназначенных для следующих целей:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/gateways, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/gateways",
"apiVersion": "2023-09-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string"
},
"properties": {
"backend": {
"subnet": {
"id": "string"
}
},
"configurationApi": {},
"frontend": {},
"virtualNetworkType": "string"
}
}
Значения свойств
Шлюзы
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ApiManagement/gateways" |
| apiVersion | Версия API ресурсов | '2023-09-01-preview' |
| имя | Имя ресурса | строка (обязательно) |
| местоположение | Расположение ресурса. | строка (обязательно) |
| Теги | Теги ресурсов. | Словарь имен и значений тегов. См. теги в шаблонах |
| SKU | Свойства SKU шлюза управления API. | ApiManagementGatewaySkuProperties (обязательно) |
| свойства | Свойства шлюза управления API. | ApiManagementGatewayProperties (обязательно) |
ApiManagementGatewayProperties
| Имя | Описание | Ценность |
|---|---|---|
| серверная часть | Сведения о том, как шлюз должен интегрироваться с внутренними системами. | BackendConfiguration |
| configurationApi | Сведения об API конфигурации шлюза управления API. Это применимо только для шлюза API со стандартным номером SKU. | GatewayConfigurationApi |
| интерфейсный интерфейс | Сведения о том, как должен предоставляться шлюз. | FrontendConfiguration |
| virtualNetworkType | Тип VPN, в котором необходимо настроить шлюз управления API. | "Внешний" "Внутренний" "Нет" |
BackendConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| подсеть | Имя узла по умолчанию шлюза плоскости данных, в который можно отправлять запросы. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| идентификатор | Идентификатор ARM подсети, в которой размещаются серверные системы. | струна |
GatewayConfigurationApi
Этот объект не содержит свойств, заданных во время развертывания. Все свойства — ReadOnly.
FrontendConfiguration
Этот объект не содержит свойств, заданных во время развертывания. Все свойства — ReadOnly.
ApiManagementGatewaySkuProperties
| Имя | Описание | Ценность |
|---|---|---|
| способность | Емкость номера SKU (количество развернутых единиц SKU) | int |
| имя | Имя SKU. | "Стандартный" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (обязательно) |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурсов шлюзов можно развернуть с помощью операций, предназначенных для следующих целей:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/gateways, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/gateways@2023-09-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
backend = {
subnet = {
id = "string"
}
}
configurationApi = {}
frontend = {}
virtualNetworkType = "string"
}
sku = {
capacity = int
name = "string"
}
})
}
Значения свойств
Шлюзы
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ApiManagement/gateways@2023-09-01-preview" |
| имя | Имя ресурса | строка (обязательно) |
| местоположение | Расположение ресурса. | строка (обязательно) |
| parent_id | Чтобы развернуть в группе ресурсов, используйте идентификатор этой группы ресурсов. | строка (обязательно) |
| Теги | Теги ресурсов. | Словарь имен и значений тегов. |
| SKU | Свойства SKU шлюза управления API. | ApiManagementGatewaySkuProperties (обязательно) |
| свойства | Свойства шлюза управления API. | ApiManagementGatewayProperties (обязательно) |
ApiManagementGatewayProperties
| Имя | Описание | Ценность |
|---|---|---|
| серверная часть | Сведения о том, как шлюз должен интегрироваться с внутренними системами. | BackendConfiguration |
| configurationApi | Сведения об API конфигурации шлюза управления API. Это применимо только для шлюза API со стандартным номером SKU. | GatewayConfigurationApi |
| интерфейсный интерфейс | Сведения о том, как должен предоставляться шлюз. | FrontendConfiguration |
| virtualNetworkType | Тип VPN, в котором необходимо настроить шлюз управления API. | "External" "Внутренний" "Нет" |
BackendConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| подсеть | Имя узла по умолчанию шлюза плоскости данных, в который можно отправлять запросы. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| идентификатор | Идентификатор ARM подсети, в которой размещаются серверные системы. | струна |
GatewayConfigurationApi
Этот объект не содержит свойств, заданных во время развертывания. Все свойства — ReadOnly.
FrontendConfiguration
Этот объект не содержит свойств, заданных во время развертывания. Все свойства — ReadOnly.
ApiManagementGatewaySkuProperties
| Имя | Описание | Ценность |
|---|---|---|
| способность | Емкость номера SKU (количество развернутых единиц SKU) | int |
| имя | Имя SKU. | "Стандартный" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (обязательно) |