Udostępnij za pośrednictwem

Microsoft.ApiManagement gateways 2023-09-01-preview

  • Artykuł

Definicja zasobu Bicep

Typ zasobu bram można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/gateways, dodaj następujący kod Bicep do szablonu.

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'
  }
}

Wartości właściwości

ApiManagementGatewayProperties

Nazwa Opis Wartość
zaplecze Informacje dotyczące sposobu integracji bramy z systemami zaplecza. BackendConfiguration
configurationApi Informacje dotyczące interfejsu API konfiguracji bramy usługi API Management. Dotyczy to tylko bramy interfejsu API z jednostkami SKU w warstwie Standardowa. GatewayConfigurationApi
fronton Informacje dotyczące sposobu uwidocznienia bramy. frontendconfiguration
virtualNetworkType Typ sieci VPN, w której należy skonfigurować bramę usługi API Management. "Zewnętrzne"
"Wewnętrzny"
"Brak"

ApiManagementGatewaySkuProperties

Nazwa Opis Wartość
pojemność Pojemność jednostki SKU (liczba wdrożonych jednostek SKU) Int
nazwa Nazwa jednostki SKU. "Standardowa"
"WorkspaceGatewayPremium"
"WorkspaceGatewayStandard" (wymagane)

ApimResourceTags

Nazwa Opis Wartość

Konfiguracja zaplecza

Nazwa Opis Wartość
podsieć Domyślna nazwa hosta bramy płaszczyzny danych, do której można wysyłać żądania. BackendSubnetConfiguration

BackendSubnetConfiguration

Nazwa Opis Wartość
id Identyfikator arm podsieci, w której są hostowane systemy zaplecza. struna

Konfiguracja frontonu

Nazwa Opis Wartość

GatewayConfigurationApi

Nazwa Opis Wartość

Microsoft.ApiManagement/gateways

Nazwa Opis Wartość
lokalizacja Lokalizacja zasobu. ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 45
Wzorzec = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (wymagane)
Właściwości Właściwości bramy usługi API Management. ApiManagementGatewayProperties (wymagane)
Numer jednostki magazynowej Właściwości jednostki SKU bramy usługi API Management. ApiManagementGatewaySkuProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Definicja zasobu szablonu usługi ARM

Typ zasobu bram można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/gateways, dodaj następujący kod JSON do szablonu.

{
  "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"
  }
}

Wartości właściwości

ApiManagementGatewayProperties

Nazwa Opis Wartość
zaplecze Informacje dotyczące sposobu integracji bramy z systemami zaplecza. BackendConfiguration
configurationApi Informacje dotyczące interfejsu API konfiguracji bramy usługi API Management. Dotyczy to tylko bramy interfejsu API z jednostkami SKU w warstwie Standardowa. GatewayConfigurationApi
fronton Informacje dotyczące sposobu uwidocznienia bramy. frontendconfiguration
virtualNetworkType Typ sieci VPN, w której należy skonfigurować bramę usługi API Management. "Zewnętrzne"
"Wewnętrzny"
"Brak"

ApiManagementGatewaySkuProperties

Nazwa Opis Wartość
pojemność Pojemność jednostki SKU (liczba wdrożonych jednostek SKU) Int
nazwa Nazwa jednostki SKU. "Standardowa"
"WorkspaceGatewayPremium"
"WorkspaceGatewayStandard" (wymagane)

ApimResourceTags

Nazwa Opis Wartość

Konfiguracja zaplecza

Nazwa Opis Wartość
podsieć Domyślna nazwa hosta bramy płaszczyzny danych, do której można wysyłać żądania. BackendSubnetConfiguration

BackendSubnetConfiguration

Nazwa Opis Wartość
id Identyfikator arm podsieci, w której są hostowane systemy zaplecza. struna

Konfiguracja frontonu

Nazwa Opis Wartość

GatewayConfigurationApi

Nazwa Opis Wartość

Microsoft.ApiManagement/gateways

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2023-09-01-preview"
lokalizacja Lokalizacja zasobu. ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 45
Wzorzec = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (wymagane)
Właściwości Właściwości bramy usługi API Management. ApiManagementGatewayProperties (wymagane)
Numer jednostki magazynowej Właściwości jednostki SKU bramy usługi API Management. ApiManagementGatewaySkuProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.ApiManagement/gateways"

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu bram można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/gateways, dodaj następujący program Terraform do szablonu.

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"
    }
  })
}

Wartości właściwości

ApiManagementGatewayProperties

Nazwa Opis Wartość
zaplecze Informacje dotyczące sposobu integracji bramy z systemami zaplecza. BackendConfiguration
configurationApi Informacje dotyczące interfejsu API konfiguracji bramy usługi API Management. Dotyczy to tylko bramy interfejsu API z jednostkami SKU w warstwie Standardowa. GatewayConfigurationApi
fronton Informacje dotyczące sposobu uwidocznienia bramy. frontendconfiguration
virtualNetworkType Typ sieci VPN, w której należy skonfigurować bramę usługi API Management. "Zewnętrzne"
"Wewnętrzny"
"Brak"

ApiManagementGatewaySkuProperties

Nazwa Opis Wartość
pojemność Pojemność jednostki SKU (liczba wdrożonych jednostek SKU) Int
nazwa Nazwa jednostki SKU. "Standardowa"
"WorkspaceGatewayPremium"
"WorkspaceGatewayStandard" (wymagane)

ApimResourceTags

Nazwa Opis Wartość

Konfiguracja zaplecza

Nazwa Opis Wartość
podsieć Domyślna nazwa hosta bramy płaszczyzny danych, do której można wysyłać żądania. BackendSubnetConfiguration

BackendSubnetConfiguration

Nazwa Opis Wartość
id Identyfikator arm podsieci, w której są hostowane systemy zaplecza. struna

Konfiguracja frontonu

Nazwa Opis Wartość

GatewayConfigurationApi

Nazwa Opis Wartość

Microsoft.ApiManagement/gateways

Nazwa Opis Wartość
lokalizacja Lokalizacja zasobu. ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 45
Wzorzec = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (wymagane)
Właściwości Właściwości bramy usługi API Management. ApiManagementGatewayProperties (wymagane)
Numer jednostki magazynowej Właściwości jednostki SKU bramy usługi API Management. ApiManagementGatewaySkuProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.ApiManagement/gateways@2023-09-01-preview"