共用方式為

Microsoft.ApiManagement 閘道 2024-05-01

  • 發行項

Bicep 資源定義

閘道資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/gateways 資源，請將下列 Bicep 新增至範本。

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

屬性值

ApiManagementGatewayProperties

名字 描述 價值
backend 閘道應如何與後端系統整合的相關信息。 BackendConfiguration
configurationApi API 管理閘道之設定 API 的相關信息。 這僅適用於具有標準 SKU 的 API 閘道。 GatewayConfigurationApi
前端 關於閘道應如何公開的資訊。 FrontendConfiguration
virtualNetworkType API 管理閘道必須在其中設定的 VPN 類型。 'External'
'Internal'
'None'

ApiManagementGatewaySkuProperties

名字 描述 價值
能力 SKU 的容量（SKU 的已部署單位數目） int
名字 Sku 的名稱。 'Standard'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' （必要）

ApimResourceTags

名字 描述 價值

BackendConfiguration

名字 描述 價值
子 可以傳送要求之數據平面閘道的預設主機名。 BackendSubnetConfiguration

BackendSubnetConfiguration

名字 描述 價值
id 後端系統裝載所在的子網 ARM 識別碼。 字串

FrontendConfiguration

名字 描述 價值

GatewayConfigurationApi

名字 描述 價值

Microsoft.ApiManagement/gateways

名字 描述 價值
位置 資源位置。 字串 （必要）
名字 資源名稱 字串

約束：
最小長度 = 1
最大長度 = 1
模式 = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ （必要）
性能 API 管理閘道的屬性。 ApiManagementGatewayProperties （必要）
sku API 管理閘道的 SKU 屬性。 ApiManagementGatewaySkuProperties （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

ARM 樣本資源定義

閘道資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/gateways 資源，請將下列 JSON 新增至範本。

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

屬性值

ApiManagementGatewayProperties

名字 描述 價值
backend 閘道應如何與後端系統整合的相關信息。 BackendConfiguration
configurationApi API 管理閘道之設定 API 的相關信息。 這僅適用於具有標準 SKU 的 API 閘道。 GatewayConfigurationApi
前端 關於閘道應如何公開的資訊。 FrontendConfiguration
virtualNetworkType API 管理閘道必須在其中設定的 VPN 類型。 'External'
'Internal'
'None'

ApiManagementGatewaySkuProperties

名字 描述 價值
能力 SKU 的容量（SKU 的已部署單位數目） int
名字 Sku 的名稱。 'Standard'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' （必要）

ApimResourceTags

名字 描述 價值

BackendConfiguration

名字 描述 價值
子 可以傳送要求之數據平面閘道的預設主機名。 BackendSubnetConfiguration

BackendSubnetConfiguration

名字 描述 價值
id 後端系統裝載所在的子網 ARM 識別碼。 字串

FrontendConfiguration

名字 描述 價值

GatewayConfigurationApi

名字 描述 價值

Microsoft.ApiManagement/gateways

名字 描述 價值
apiVersion API 版本 '2024-05-01'
位置 資源位置。 字串 （必要）
名字 資源名稱 字串

約束：
最小長度 = 1
最大長度 = 1
模式 = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ （必要）
性能 API 管理閘道的屬性。 ApiManagementGatewayProperties （必要）
sku API 管理閘道的 SKU 屬性。 ApiManagementGatewaySkuProperties （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
類型 資源類型 'Microsoft.ApiManagement/gateways'

Terraform （AzAPI 提供者） 資源定義

閘道資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/gateways 資源，請將下列 Terraform 新增至您的範本。

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

屬性值

ApiManagementGatewayProperties

名字 描述 價值
backend 閘道應如何與後端系統整合的相關信息。 BackendConfiguration
configurationApi API 管理閘道之設定 API 的相關信息。 這僅適用於具有標準 SKU 的 API 閘道。 GatewayConfigurationApi
前端 關於閘道應如何公開的資訊。 FrontendConfiguration
virtualNetworkType API 管理閘道必須在其中設定的 VPN 類型。 'External'
'Internal'
'None'

ApiManagementGatewaySkuProperties

名字 描述 價值
能力 SKU 的容量（SKU 的已部署單位數目） int
名字 Sku 的名稱。 'Standard'
'WorkspaceGatewayPremium'
'WorkspaceGatewayStandard' （必要）

ApimResourceTags

名字 描述 價值

BackendConfiguration

名字 描述 價值
子 可以傳送要求之數據平面閘道的預設主機名。 BackendSubnetConfiguration

BackendSubnetConfiguration

名字 描述 價值
id 後端系統裝載所在的子網 ARM 識別碼。 字串

FrontendConfiguration

名字 描述 價值

GatewayConfigurationApi

名字 描述 價值

Microsoft.ApiManagement/gateways

名字 描述 價值
位置 資源位置。 字串 （必要）
名字 資源名稱 字串

約束：
最小長度 = 1
最大長度 = 1
模式 = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ （必要）
性能 API 管理閘道的屬性。 ApiManagementGatewayProperties （必要）
sku API 管理閘道的 SKU 屬性。 ApiManagementGatewaySkuProperties （必要）
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.ApiManagement/gateways@2024-05-01”