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

快速入门:使用 ARM 模板创建新的 Azure API 管理服务实例

本快速入门介绍如何使用 Azure 资源管理器模板(ARM 模板)创建 Azure API 管理 (APIM) 服务实例。 APIM 可帮助组织将 API 发布到外部、合作伙伴和内部开发人员,以发挥其数据和服务的潜力。 API 管理通过开发人员参与、商业洞察力、分析、安全性和保护提供了核心竞争力以确保成功的 API 程序。 使用 APIM 可以为在任何位置托管的现有后端服务创建和管理新式 API 网关。 有关详细信息,请参阅概述

资源管理器模板是定义项目基础结构和配置的 JavaScript 对象表示法 (JSON) 文件。 模板使用声明性语法。 在声明性语法中,你可以在不编写创建部署的编程命令序列的情况下,描述预期部署。

如果你的环境满足先决条件,并且你熟悉如何使用 ARM 模板,请选择“部署到 Azure”按钮。 Azure 门户中会打开模板。

部署到 Azure

先决条件

如果没有 Azure 订阅,请在开始之前创建一个免费帐户

查看模板

本快速入门中使用的模板来自 Azure 快速启动模板

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "metadata": {
    "_generator": {
      "name": "bicep",
      "version": "0.5.6.12127",
      "templateHash": "6751554658084889632"
    }
  },
  "parameters": {
    "apiManagementServiceName": {
      "type": "string",
      "defaultValue": "[format('apiservice{0}', uniqueString(resourceGroup().id))]",
      "metadata": {
        "description": "The name of the API Management service instance"
      }
    },
    "publisherEmail": {
      "type": "string",
      "minLength": 1,
      "metadata": {
        "description": "The email address of the owner of the service"
      }
    },
    "publisherName": {
      "type": "string",
      "minLength": 1,
      "metadata": {
        "description": "The name of the owner of the service"
      }
    },
    "sku": {
      "type": "string",
      "defaultValue": "Developer",
      "allowedValues": [
        "Developer",
        "Standard",
        "Premium"
      ],
      "metadata": {
        "description": "The pricing tier of this API Management service"
      }
    },
    "skuCount": {
      "type": "int",
      "defaultValue": 1,
      "allowedValues": [
        1,
        2
      ],
      "metadata": {
        "description": "The instance size of this API Management service."
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "Location for all resources."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.ApiManagement/service",
      "apiVersion": "2021-08-01",
      "name": "[parameters('apiManagementServiceName')]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "[parameters('sku')]",
        "capacity": "[parameters('skuCount')]"
      },
      "properties": {
        "publisherEmail": "[parameters('publisherEmail')]",
        "publisherName": "[parameters('publisherName')]"
      }
    }
  ]
}

模板中定义了以下资源:

可以在 Azure 快速入门模板中找到更多 Azure API 管理模板示例。

部署模板

  1. 选择下图登录到 Azure 并打开一个模板。 该模板将创建一个具有自动生成名称的 API 管理服务实例。

    部署到 Azure

    在此示例中,该实例在“开发人员”层配置,这是评估 Azure API 管理的一个经济选择。 此层不用于生产。 有关对 API 管理层进行缩放的详细信息,请参阅升级和缩放

  2. 选择或输入以下值。

    • 订阅:选择一个 Azure 订阅。
    • 资源组:选择“新建”,为资源组输入一个独一无二的名称,然后选择“确定”。
    • 区域:选择资源组的位置。 示例:“美国中部”。
    • 发布服务器电子邮件:输入电子邮件地址以接收通知。
    • 发布服务器名称:输入为 API 发布服务器选择的名称。
    • Sku:接受“开发人员”的默认值。
    • Sku 计数:接受默认值。
    • 位置:接受 API 管理服务的生成位置。

    API 管理模板属性

  3. 选择“查看 + 创建”,然后查看条款和条件。 如果同意,请选择“创建”。

    提示

    在“开发人员”层中创建和激活 API 管理服务可能需要 30 到 40 分钟。

  4. 成功创建实例后,你会收到通知:

    部署通知

使用 Azure 门户部署模板。 除了 Azure 门户,还可以使用 Azure PowerShell、Azure CLI 和 REST API。 若要了解其他部署方法,请参阅部署模板

查看已部署的资源

请使用 Azure 门户来检查已部署的资源,也可以使用 Azure CLI 或 Azure PowerShell 等工具列出已部署的资源。

  1. Azure 门户中,搜索并选择“API 管理服务”,然后选择所创建的服务实例。
  2. 在“概览”页上查看服务的属性。

服务概述页

当 API 管理服务实例处于联机状态时,便可以使用它了。 从教程开始导入并发布你的第一个 API。

清理资源

如果打算继续使用后续的教程,你可能需要保留 API 管理实例。 如果不再需要资源组,可以将其删除,这将删除资源组中的资源。

  1. Azure 门户中,搜索并选择“资源组”。 还可以在“主页”上选择“资源组”

  2. 在“资源组”页上,选择相应资源组

  3. 在资源组页上,选择“删除资源组”

    删除资源组

  4. 键入资源组的名称,然后选择“删除”

后续步骤