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

Microsoft.ApiManagement 服务 2016-07-07

• 最新
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01
• 2016-10-10
• 2016-07-07

Bicep 资源定义

可以使用目标操作部署服务资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.ApiManagement/service@2016-07-07' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    additionalLocations: [
      {
        location: 'string'
        skuType: 'string'
        skuUnitCount: int
        vpnconfiguration: {
          location: 'string'
          subnetResourceId: 'string'
        }
      }
    ]
    addresserEmail: 'string'
    customProperties: {
      {customized property}: 'string'
    }
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        hostname: 'string'
        type: 'string'
      }
    ]
    publisherEmail: 'string'
    publisherName: 'string'
    vpnconfiguration: {
      location: 'string'
      subnetResourceId: 'string'
    }
    vpnType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AdditionalRegion

名字	描述	价值
位置	Azure 数据中心区域中其他区域的位置名称。	string （必需）
skuType	位置中的 SKU 类型。	“Developer” “Premium” “标准”（必需）
skuUnitCount	位置的 SKU 单位计数。 最大 SKU 单位计数取决于 SkuType。 开发人员 SKU 允许的最大值为 1，标准 SKU 为 4，高级 SKU 在某个位置为 10。	int 约束： 最大值 = 10
vpnconfiguration	位置的虚拟网络配置。	VirtualNetworkConfiguration

ApiManagementServiceBaseParametersTags

名字	描述	价值

ApiManagementServiceProperties

名字	描述	价值
additionalLocations	API 管理服务的其他数据中心位置。	AdditionalRegion[]
addresserEmail	地址器电子邮件。	字符串
customProperties	API 管理服务的自定义属性，例如禁用 TLS 1.0。	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	API 管理服务的自定义主机名配置。	HostnameConfiguration[]
publisherEmail	发布者电子邮件。	字符串 约束： 最大长度 = （必需）
publisherName	发布者名称。	string （必需）
vpnconfiguration	API 管理服务的虚拟网络配置。	VirtualNetworkConfiguration
vpnType	需要在其中配置 API 管理服务的 VPN 类型。 无（默认值）表示 API 管理服务不是任何虚拟网络的一部分，外部意味着 API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，内部意味着 API 管理部署仅在具有 Intranet 面向终结点的虚拟网络中进行设置。	“External” “Internal” “None”

ApiManagementServicePropertiesCustomProperties

名字	描述	价值

ApiManagementServiceSkuProperties

名字	描述	价值
能力	SKU 的容量（SKU 的已部署单位数）。 默认值为 1。	int
名字	Sku 的名称。	“Developer” “Premium” “标准”（必需）

CertificateInformation

名字	描述	价值
满期	证书的到期日期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。	string （必需）
主题	证书的使用者。	string （必需）
指纹	证书的指纹。	string （必需）

HostnameConfiguration

名字	描述	价值
证书	证书信息。	CertificateInformation （必需）
hostname	主机名。	string （必需）
类型	主机名类型。	“管理” “Portal” “Proxy” “Scm”（必需）

Microsoft.ApiManagement/service

名字	描述	价值
etag	资源的 ETag。	字符串
位置	API 管理服务的数据中心位置。	string （必需）
名字	资源名称	字符串 约束： 最小长度 = 1 最大长度 = 1 模式 = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ （必需）
性能	API 管理服务的属性。	ApiManagementServiceProperties
sku	API 管理服务的 SKU 属性。	ApiManagementServiceSkuProperties
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

VirtualNetworkConfiguration

名字	描述	价值
位置	虚拟网络的位置。	字符串
subnetResourceId	子网资源 ID 的名称。 此格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft。{Network	ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}。	字符串

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
使用内部 API 管理和 Web 应用 应用程序网关	应用程序网关将 Internet 流量路由到虚拟网络（内部模式）API 管理实例，该实例服务 Azure Web 应用中托管的 Web API。
创建多区域高级层 API 管理实例	此模板演示如何创建具有其他位置的 API 管理实例。 主要位置与资源组的位置相同。 对于其他位置，模板显示 NorthCentralUs 和美国东部 2。 主要位置应不同于其他位置。
创建具有 MSI 标识 的 API 管理实例	此模板创建具有 MSI 标识的 Azure API 管理的开发人员实例
使用模板创建 API 管理实例	此模板创建 Azure API 管理的开发人员实例
使用专用终结点创建 API 管理服务	此模板将创建 API 管理服务、虚拟网络和专用终结点，向虚拟网络公开 API 管理服务。
从 KeyVault 使用 SSL 创建 API 管理服务	此模板部署配置有用户分配标识的 API 管理服务。 它使用此标识从 KeyVault 提取 SSL 证书，并通过每隔 4 小时检查一次来更新它。
使用应用网关在内部 VNet 中创建 API 管理	此模板演示如何在受 Azure 应用程序网关保护的专用网络上创建 Azure API 管理的实例。
使用公共 IP 在外部 VNet 中部署 API 管理	此模板演示如何在虚拟网络子网的外部模式下的高级层中创建 Azure API 管理的实例，并在子网上配置建议的 NSG 规则。 实例部署到两个可用性区域。 该模板还配置订阅中的公共 IP 地址。
使用公共 IP 在内部 VNet 中部署 API 管理	此模板演示如何在虚拟网络子网内部的高级层中创建 Azure API 管理的实例，并在子网上配置建议的 NSG 规则。 实例部署到两个可用性区域。 该模板还配置订阅中的公共 IP 地址。
将 API 管理部署到可用性区域	此模板创建 Azure API 管理的高级实例，并将其部署到可用性区域
使用外部 Azure Redis 缓存部署 API 管理	此模板演示如何使用外部 Azure Redis 缓存实例作为 API 管理外部缓存在消耗层中创建 Azure API 管理的实例。
使用 API 管理源 Front Door 标准版/高级版	此模板创建 Front Door Premium 和 API 管理实例，并使用 NSG 和全局 API 管理策略来验证流量是否通过 Front Door 源。

ARM 模板资源定义

可以使用目标操作部署服务资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2016-07-07",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "additionalLocations": [
      {
        "location": "string",
        "skuType": "string",
        "skuUnitCount": "int",
        "vpnconfiguration": {
          "location": "string",
          "subnetResourceId": "string"
        }
      }
    ],
    "addresserEmail": "string",
    "customProperties": {
      "{customized property}": "string"
    },
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "hostname": "string",
        "type": "string"
      }
    ],
    "publisherEmail": "string",
    "publisherName": "string",
    "vpnconfiguration": {
      "location": "string",
      "subnetResourceId": "string"
    },
    "vpnType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AdditionalRegion

名字	描述	价值
位置	Azure 数据中心区域中其他区域的位置名称。	string （必需）
skuType	位置中的 SKU 类型。	“Developer” “Premium” “标准”（必需）
skuUnitCount	位置的 SKU 单位计数。 最大 SKU 单位计数取决于 SkuType。 开发人员 SKU 允许的最大值为 1，标准 SKU 为 4，高级 SKU 在某个位置为 10。	int 约束： 最大值 = 10
vpnconfiguration	位置的虚拟网络配置。	VirtualNetworkConfiguration

ApiManagementServiceBaseParametersTags

名字	描述	价值

ApiManagementServiceProperties

名字	描述	价值
additionalLocations	API 管理服务的其他数据中心位置。	AdditionalRegion[]
addresserEmail	地址器电子邮件。	字符串
customProperties	API 管理服务的自定义属性，例如禁用 TLS 1.0。	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	API 管理服务的自定义主机名配置。	HostnameConfiguration[]
publisherEmail	发布者电子邮件。	字符串 约束： 最大长度 = （必需）
publisherName	发布者名称。	string （必需）
vpnconfiguration	API 管理服务的虚拟网络配置。	VirtualNetworkConfiguration
vpnType	需要在其中配置 API 管理服务的 VPN 类型。 无（默认值）表示 API 管理服务不是任何虚拟网络的一部分，外部意味着 API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，内部意味着 API 管理部署仅在具有 Intranet 面向终结点的虚拟网络中进行设置。	“External” “Internal” “None”

ApiManagementServicePropertiesCustomProperties

名字	描述	价值

ApiManagementServiceSkuProperties

名字	描述	价值
能力	SKU 的容量（SKU 的已部署单位数）。 默认值为 1。	int
名字	Sku 的名称。	“Developer” “Premium” “标准”（必需）

CertificateInformation

名字	描述	价值
满期	证书的到期日期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。	string （必需）
主题	证书的使用者。	string （必需）
指纹	证书的指纹。	string （必需）

HostnameConfiguration

名字	描述	价值
证书	证书信息。	CertificateInformation （必需）
hostname	主机名。	string （必需）
类型	主机名类型。	“管理” “Portal” “Proxy” “Scm”（必需）

Microsoft.ApiManagement/service

名字	描述	价值
apiVersion	API 版本	'2016-07-07'
etag	资源的 ETag。	字符串
位置	API 管理服务的数据中心位置。	string （必需）
名字	资源名称	字符串 约束： 最小长度 = 1 最大长度 = 1 模式 = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ （必需）
性能	API 管理服务的属性。	ApiManagementServiceProperties
sku	API 管理服务的 SKU 属性。	ApiManagementServiceSkuProperties
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.ApiManagement/service”

VirtualNetworkConfiguration

名字	描述	价值
位置	虚拟网络的位置。	字符串
subnetResourceId	子网资源 ID 的名称。 此格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft。{Network	ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}。	字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
使用内部 API 管理和 Web 应用 应用程序网关	应用程序网关将 Internet 流量路由到虚拟网络（内部模式）API 管理实例，该实例服务 Azure Web 应用中托管的 Web API。
创建多区域高级层 API 管理实例	此模板演示如何创建具有其他位置的 API 管理实例。 主要位置与资源组的位置相同。 对于其他位置，模板显示 NorthCentralUs 和美国东部 2。 主要位置应不同于其他位置。
使用模板 创建 API 管理实例和所有子资源	此模板演示如何创建 API 管理服务并配置子实体
创建具有 MSI 标识 的 API 管理实例	此模板创建具有 MSI 标识的 Azure API 管理的开发人员实例
使用模板创建 API 管理实例	此模板创建 Azure API 管理的开发人员实例
使用自定义主机名创建 API 管理实例	此模板演示如何使用门户的自定义主机名和代理的多个自定义主机名创建 Azure API 管理的实例
使用专用终结点创建 API 管理服务	此模板将创建 API 管理服务、虚拟网络和专用终结点，向虚拟网络公开 API 管理服务。
从 KeyVault 使用 SSL 创建 API 管理服务	此模板部署配置有用户分配标识的 API 管理服务。 它使用此标识从 KeyVault 提取 SSL 证书，并通过每隔 4 小时检查一次来更新它。
创建和监视 API 管理实例	此模板创建 Azure API 管理服务和 Log Analytics 工作区的实例，并使用 Log Analytics 为 API 管理服务设置监视
使用应用网关在内部 VNet 中创建 API 管理	此模板演示如何在受 Azure 应用程序网关保护的专用网络上创建 Azure API 管理的实例。
使用 KeyVault 使用自定义代理 ssl 创建 API 管理	此模板演示如何使用 keyvault 中的 ssl 证书为代理创建 Azure API 管理的实例和配置自定义主机名。
在 Azure API 管理 前创建 Azure Front Door	此示例演示如何在 Azure API 管理之前将 Azure Front Door 用作全局负载均衡器。
使用公共 IP 在外部 VNet 中部署 API 管理	此模板演示如何在虚拟网络子网的外部模式下的高级层中创建 Azure API 管理的实例，并在子网上配置建议的 NSG 规则。 实例部署到两个可用性区域。 该模板还配置订阅中的公共 IP 地址。
使用公共 IP 在内部 VNet 中部署 API 管理	此模板演示如何在虚拟网络子网内部的高级层中创建 Azure API 管理的实例，并在子网上配置建议的 NSG 规则。 实例部署到两个可用性区域。 该模板还配置订阅中的公共 IP 地址。
将 API 管理部署到可用性区域	此模板创建 Azure API 管理的高级实例，并将其部署到可用性区域
使用外部 Azure Redis 缓存部署 API 管理	此模板演示如何使用外部 Azure Redis 缓存实例作为 API 管理外部缓存在消耗层中创建 Azure API 管理的实例。
使用 API 管理源 Front Door 标准版/高级版	此模板创建 Front Door Premium 和 API 管理实例，并使用 NSG 和全局 API 管理策略来验证流量是否通过 Front Door 源。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署服务资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2016-07-07"
  name = "string"
  etag = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          location = "string"
          skuType = "string"
          skuUnitCount = int
          vpnconfiguration = {
            location = "string"
            subnetResourceId = "string"
          }
        }
      ]
      addresserEmail = "string"
      customProperties = {
        {customized property} = "string"
      }
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          hostname = "string"
          type = "string"
        }
      ]
      publisherEmail = "string"
      publisherName = "string"
      vpnconfiguration = {
        location = "string"
        subnetResourceId = "string"
      }
      vpnType = "string"
    }
  })
}

属性值

AdditionalRegion

名字	描述	价值
位置	Azure 数据中心区域中其他区域的位置名称。	string （必需）
skuType	位置中的 SKU 类型。	“Developer” “Premium” “标准”（必需）
skuUnitCount	位置的 SKU 单位计数。 最大 SKU 单位计数取决于 SkuType。 开发人员 SKU 允许的最大值为 1，标准 SKU 为 4，高级 SKU 在某个位置为 10。	int 约束： 最大值 = 10
vpnconfiguration	位置的虚拟网络配置。	VirtualNetworkConfiguration

ApiManagementServiceBaseParametersTags

名字	描述	价值

ApiManagementServiceProperties

名字	描述	价值
additionalLocations	API 管理服务的其他数据中心位置。	AdditionalRegion[]
addresserEmail	地址器电子邮件。	字符串
customProperties	API 管理服务的自定义属性，例如禁用 TLS 1.0。	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	API 管理服务的自定义主机名配置。	HostnameConfiguration[]
publisherEmail	发布者电子邮件。	字符串 约束： 最大长度 = （必需）
publisherName	发布者名称。	string （必需）
vpnconfiguration	API 管理服务的虚拟网络配置。	VirtualNetworkConfiguration
vpnType	需要在其中配置 API 管理服务的 VPN 类型。 无（默认值）表示 API 管理服务不是任何虚拟网络的一部分，外部意味着 API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，内部意味着 API 管理部署仅在具有 Intranet 面向终结点的虚拟网络中进行设置。	“External” “Internal” “None”

ApiManagementServicePropertiesCustomProperties

名字	描述	价值

ApiManagementServiceSkuProperties

名字	描述	价值
能力	SKU 的容量（SKU 的已部署单位数）。 默认值为 1。	int
名字	Sku 的名称。	“Developer” “Premium” “标准”（必需）

CertificateInformation

名字	描述	价值
满期	证书的到期日期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。	string （必需）
主题	证书的使用者。	string （必需）
指纹	证书的指纹。	string （必需）

HostnameConfiguration

名字	描述	价值
证书	证书信息。	CertificateInformation （必需）
hostname	主机名。	string （必需）
类型	主机名类型。	“管理” “Portal” “Proxy” “Scm”（必需）

Microsoft.ApiManagement/service

名字	描述	价值
etag	资源的 ETag。	字符串
位置	API 管理服务的数据中心位置。	string （必需）
名字	资源名称	字符串 约束： 最小长度 = 1 最大长度 = 1 模式 = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ （必需）
性能	API 管理服务的属性。	ApiManagementServiceProperties
sku	API 管理服务的 SKU 属性。	ApiManagementServiceSkuProperties
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.ApiManagement/service@2016-07-07”

VirtualNetworkConfiguration

名字	描述	价值
位置	虚拟网络的位置。	字符串
subnetResourceId	子网资源 ID 的名称。 此格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft。{Network	ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}。	字符串