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

快速入门：使用 Azure CLI 创建新的 Azure API 管理实例

项目
04/08/2024

适用于：消耗 | 开发人员 | 基本 | 标准 | 高级

本快速入门介绍使用 Azure CLI 命令创建新的 API 管理实例的步骤。创建实例后，可以使用 Azure CLI 执行常见管理任务，例如在 API 管理实例中导入 API。

Azure API 管理可帮助组织将 API 发布给外部、合作伙伴和内部开发人员，以充分发挥其数据和服务的潜力。 API 管理通过开发人员参与、商业洞察力、分析、安全性和保护提供了核心竞争力以确保成功的 API 程序。使用 API 管理，为托管在任何位置的现有后端服务创建和管理新式 API 网关。

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

先决条件

在 Azure Cloud Shell 中使用 Bash 环境。有关详细信息，请参阅 Azure Cloud Shell 中的 Bash 快速入门。
如需在本地运行 CLI 参考命令，请安装 Azure CLI。如果在 Windows 或 macOS 上运行，请考虑在 Docker 容器中运行 Azure CLI。有关详细信息，请参阅如何在 Docker 容器中运行 Azure CLI。
- 如果使用的是本地安装，请使用 az login 命令登录到 Azure CLI。若要完成身份验证过程，请遵循终端中显示的步骤。有关其他登录选项，请参阅使用 Azure CLI 登录。
- 出现提示时，请在首次使用时安装 Azure CLI 扩展。有关扩展详细信息，请参阅使用 Azure CLI 的扩展。
- 运行 az version 以查找安装的版本和依赖库。若要升级到最新版本，请运行 az upgrade。

本文需要 Azure CLI 版本 2.11.1 或更高版本。如果使用 Azure Cloud Shell，则最新版本已安装。

创建资源组

Azure API 管理实例像所有 Azure 资源一样必须部署到资源组中。使用资源组可以组织和管理相关的 Azure 资源。

首先，使用以下 az group create 命令在“美国中部”位置中创建一个名为“myResourceGroup”的资源组：

az group create --name myResourceGroup --location centralus

创建 API 管理实例

现在你已经有了一个资源组，可以创建 API 管理实例了。使用 az apim create 命令创建一个，并提供服务名称和发布者详细信息。服务名称在 Azure 中必须独一无二。

在下面的示例中，使用“myapim”作为服务名称。将该名称更新为唯一值。同时更新 API 发布者的组织的名称以及用于接收通知的电子邮件地址。

az apim create --name myapim --resource-group myResourceGroup \
  --publisher-name Contoso --publisher-email admin@contoso.com \
  --no-wait

默认情况下，该命令在“开发人员”层创建实例，这是评估 Azure API 管理的一个经济选择。此层不用于生产。有关对 API 管理层进行缩放的详细信息，请参阅升级和缩放。

提示

在此层中创建和激活 API 管理服务可能需要 30 到 40 分钟。上一命令使用了 --no-wait 选项，因此在创建服务后该命令会立即返回。

通过运行 az apim show 命令检查部署的状态：

az apim show --name myapim --resource-group myResourceGroup --output table

最初，输出类似于以下内容，显示了 Activating 状态：

NAME         RESOURCE GROUP    LOCATION    GATEWAY ADDR    PUBLIC IP    PRIVATE IP    STATUS      TIER       UNITS
-----------  ----------------  ----------  --------------  -----------  ------------  ----------  ---------  -------
myapim       myResourceGroup   Central US                                             Activating  Developer  1

激活后，状态为 Online，服务实例有网关地址和公共 IP 地址。目前，这些地址不会公开任何内容。例如：。

NAME         RESOURCE GROUP    LOCATION    GATEWAY ADDR                       PUBLIC IP     PRIVATE IP    STATUS    TIER       UNITS
-----------  ----------------  ----------  ---------------------------------  ------------  ------------  --------  ---------  -------
myapim       myResourceGroup   Central US  https://myapim.azure-api.net       203.0.113.1                 Online    Developer  1

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

清理资源

如果不再需要资源组和 API 管理服务实例，可以使用 az group delete 命令将其删除。

az group delete --name myResourceGroup

后续步骤

导入和发布第一个 API

通过