你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.ApiManagement 网关 2024-05-01

• 最新
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview

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

名字	描述	价值
后端	有关网关应如何与后端系统集成的信息。	BackendConfiguration
configurationApi	有关 API 管理网关的配置 API 的信息。 这仅适用于具有标准 SKU 的 API 网关。	GatewayConfigurationApi
frontend	有关如何公开网关的信息。	FrontendConfiguration
virtualNetworkType	需要在其中配置 API 管理网关的 VPN 类型。	“External” “Internal” “None”

ApiManagementGatewaySkuProperties

名字	描述	价值
能力	SKU 的容量（SKU 的已部署单位数）	int
名字	Sku 的名称。	“Standard” “WorkspaceGatewayPremium” “WorkspaceGatewayStandard”（必需）

ApimResourceTags

名字	描述	价值

BackendConfiguration

名字	描述	价值
子	可以向其发送请求的数据平面网关的默认主机名。	BackendSubnetConfiguration

BackendSubnetConfiguration

名字	描述	价值
id	在其中托管后端系统的子网的 ARM ID。	字符串

FrontendConfiguration

名字	描述	价值

GatewayConfigurationApi

名字	描述	价值

Microsoft.ApiManagement/gateways

名字	描述	价值
位置	资源位置。	string （必需）
名字	资源名称	字符串 约束： 最小长度 = 1 最大长度 = 45 模式 = ^[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

名字	描述	价值
后端	有关网关应如何与后端系统集成的信息。	BackendConfiguration
configurationApi	有关 API 管理网关的配置 API 的信息。 这仅适用于具有标准 SKU 的 API 网关。	GatewayConfigurationApi
frontend	有关如何公开网关的信息。	FrontendConfiguration
virtualNetworkType	需要在其中配置 API 管理网关的 VPN 类型。	“External” “Internal” “None”

ApiManagementGatewaySkuProperties

名字	描述	价值
能力	SKU 的容量（SKU 的已部署单位数）	int
名字	Sku 的名称。	“Standard” “WorkspaceGatewayPremium” “WorkspaceGatewayStandard”（必需）

ApimResourceTags

名字	描述	价值

BackendConfiguration

名字	描述	价值
子	可以向其发送请求的数据平面网关的默认主机名。	BackendSubnetConfiguration

BackendSubnetConfiguration

名字	描述	价值
id	在其中托管后端系统的子网的 ARM ID。	字符串

FrontendConfiguration

名字	描述	价值

GatewayConfigurationApi

名字	描述	价值

Microsoft.ApiManagement/gateways

名字	描述	价值
apiVersion	API 版本	'2024-05-01'
位置	资源位置。	string （必需）
名字	资源名称	字符串 约束： 最小长度 = 1 最大长度 = 45 模式 = ^[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

名字	描述	价值
后端	有关网关应如何与后端系统集成的信息。	BackendConfiguration
configurationApi	有关 API 管理网关的配置 API 的信息。 这仅适用于具有标准 SKU 的 API 网关。	GatewayConfigurationApi
frontend	有关如何公开网关的信息。	FrontendConfiguration
virtualNetworkType	需要在其中配置 API 管理网关的 VPN 类型。	“External” “Internal” “None”

ApiManagementGatewaySkuProperties

名字	描述	价值
能力	SKU 的容量（SKU 的已部署单位数）	int
名字	Sku 的名称。	“Standard” “WorkspaceGatewayPremium” “WorkspaceGatewayStandard”（必需）

ApimResourceTags

名字	描述	价值

BackendConfiguration

名字	描述	价值
子	可以向其发送请求的数据平面网关的默认主机名。	BackendSubnetConfiguration

BackendSubnetConfiguration

名字	描述	价值
id	在其中托管后端系统的子网的 ARM ID。	字符串

FrontendConfiguration

名字	描述	价值

GatewayConfigurationApi

名字	描述	价值

Microsoft.ApiManagement/gateways

名字	描述	价值
位置	资源位置。	string （必需）
名字	资源名称	字符串 约束： 最小长度 = 1 最大长度 = 45 模式 = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ （必需）
性能	API 管理网关的属性。	ApiManagementGatewayProperties（必需）
sku	API 管理网关的 SKU 属性。	ApiManagementGatewaySkuProperties（必需）
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.ApiManagement/gateways@2024-05-01”