Microsoft.ApiManagement gateways 2024-05-01
Bicep-resursdefinition
Resurstypen gatewayer kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/gateways-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/gateways@2024-05-01' = {
location: 'string'
name: 'string'
properties: {
backend: {
subnet: {
id: 'string'
}
}
configurationApi: {}
frontend: {}
virtualNetworkType: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Egenskapsvärden
ApiManagementGatewayProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| serverdel | Information om hur gatewayen ska integreras med serverdelssystem. | BackendConfiguration |
| configurationApi | Information om API-konfigurations-API:et för API Management-gatewayen. Detta gäller endast för API-gateway med Standard SKU. | GatewayConfigurationApi |
| klientdel | Information om hur gatewayen ska exponeras. | FrontendConfiguration |
| virtualNetworkType | Den typ av VPN som API Management-gatewayen måste konfigureras i. | "Extern" "Internt" "Ingen" |
ApiManagementGatewaySkuProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| kapacitet | SKU:ns kapacitet (antalet distribuerade enheter i SKU:n) | Int |
| Namn | Namnet på SKU:n. | "Standard" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (krävs) |
ApimResourceTags
| Namn | Beskrivning | Värde |
|---|
BackendConfiguration
| Namn | Beskrivning | Värde |
|---|---|---|
| Undernät | Standardvärdnamnet för den dataplansgateway som begäranden kan skickas till. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Namn | Beskrivning | Värde |
|---|---|---|
| Id | ARM-ID:t för det undernät där serverdelssystemen finns. | sträng |
FrontendConfiguration
| Namn | Beskrivning | Värde |
|---|
GatewayConfigurationApi
| Namn | Beskrivning | Värde |
|---|
Microsoft.ApiManagement/gateways
| Namn | Beskrivning | Värde |
|---|---|---|
| plats | Resursplats. | sträng (krävs) |
| Namn | Resursnamnet | sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (krävs) |
| Egenskaper | Egenskaper för API Management-gatewayen. | ApiManagementGatewayProperties (krävs) |
| Sku | SKU-egenskaper för API Management-gatewayen. | ApiManagementGatewaySkuProperties (krävs) |
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
Resursdefinition för ARM-mall
Resurstypen gatewayer kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/gateways-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/gateways",
"apiVersion": "2024-05-01",
"name": "string",
"location": "string",
"properties": {
"backend": {
"subnet": {
"id": "string"
}
},
"configurationApi": {
},
"frontend": {
},
"virtualNetworkType": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Egenskapsvärden
ApiManagementGatewayProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| serverdel | Information om hur gatewayen ska integreras med serverdelssystem. | BackendConfiguration |
| configurationApi | Information om API-konfigurations-API:et för API Management-gatewayen. Detta gäller endast för API-gateway med Standard SKU. | GatewayConfigurationApi |
| klientdel | Information om hur gatewayen ska exponeras. | FrontendConfiguration |
| virtualNetworkType | Den typ av VPN som API Management-gatewayen måste konfigureras i. | "Extern" "Internt" "Ingen" |
ApiManagementGatewaySkuProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| kapacitet | SKU:ns kapacitet (antalet distribuerade enheter i SKU:n) | Int |
| Namn | Namnet på SKU:n. | "Standard" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (krävs) |
ApimResourceTags
| Namn | Beskrivning | Värde |
|---|
BackendConfiguration
| Namn | Beskrivning | Värde |
|---|---|---|
| Undernät | Standardvärdnamnet för den dataplansgateway som begäranden kan skickas till. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Namn | Beskrivning | Värde |
|---|---|---|
| Id | ARM-ID:t för det undernät där serverdelssystemen finns. | sträng |
FrontendConfiguration
| Namn | Beskrivning | Värde |
|---|
GatewayConfigurationApi
| Namn | Beskrivning | Värde |
|---|
Microsoft.ApiManagement/gateways
| Namn | Beskrivning | Värde |
|---|---|---|
| apiVersion | API-versionen | '2024-05-01' |
| plats | Resursplats. | sträng (krävs) |
| Namn | Resursnamnet | sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (krävs) |
| Egenskaper | Egenskaper för API Management-gatewayen. | ApiManagementGatewayProperties (krävs) |
| Sku | SKU-egenskaper för API Management-gatewayen. | ApiManagementGatewaySkuProperties (krävs) |
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
| typ | Resurstypen | "Microsoft.ApiManagement/gateways" |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen gatewayer kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/gateways-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/gateways@2024-05-01"
name = "string"
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
backend = {
subnet = {
id = "string"
}
}
configurationApi = {
}
frontend = {
}
virtualNetworkType = "string"
}
})
}
Egenskapsvärden
ApiManagementGatewayProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| serverdel | Information om hur gatewayen ska integreras med serverdelssystem. | BackendConfiguration |
| configurationApi | Information om API-konfigurations-API:et för API Management-gatewayen. Detta gäller endast för API-gateway med Standard SKU. | GatewayConfigurationApi |
| klientdel | Information om hur gatewayen ska exponeras. | FrontendConfiguration |
| virtualNetworkType | Den typ av VPN som API Management-gatewayen måste konfigureras i. | "Extern" "Internt" "Ingen" |
ApiManagementGatewaySkuProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| kapacitet | SKU:ns kapacitet (antalet distribuerade enheter i SKU:n) | Int |
| Namn | Namnet på SKU:n. | "Standard" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (krävs) |
ApimResourceTags
| Namn | Beskrivning | Värde |
|---|
BackendConfiguration
| Namn | Beskrivning | Värde |
|---|---|---|
| Undernät | Standardvärdnamnet för den dataplansgateway som begäranden kan skickas till. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Namn | Beskrivning | Värde |
|---|---|---|
| Id | ARM-ID:t för det undernät där serverdelssystemen finns. | sträng |
FrontendConfiguration
| Namn | Beskrivning | Värde |
|---|
GatewayConfigurationApi
| Namn | Beskrivning | Värde |
|---|
Microsoft.ApiManagement/gateways
| Namn | Beskrivning | Värde |
|---|---|---|
| plats | Resursplats. | sträng (krävs) |
| Namn | Resursnamnet | sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (krävs) |
| Egenskaper | Egenskaper för API Management-gatewayen. | ApiManagementGatewayProperties (krävs) |
| Sku | SKU-egenskaper för API Management-gatewayen. | ApiManagementGatewaySkuProperties (krävs) |
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. |
| typ | Resurstypen | "Microsoft.ApiManagement/gateways@2024-05-01" |