你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
适用于:消耗 | 开发人员 | 基本 | 标准 | 高级
本快速入门介绍使用 Azure CLI 命令创建新的 API 管理实例的步骤。 创建实例后,可以使用 Azure CLI 执行常见管理任务,例如在 API 管理实例中导入 API。
Azure API 管理可帮助组织将 API 发布给外部、合作伙伴和内部开发人员,以充分发挥其数据和服务的潜力。 API 管理通过开发人员参与、商业洞察力、分析、安全性和保护提供了核心竞争力以确保成功的 API 程序。 使用 API 管理,可以为托管在任何位置的现有后端服务创建和管理新式 API 网关。
如果没有 Azure 帐户,请在开始前创建一个免费帐户。
先决条件
在 Azure Cloud Shell 中使用 Bash 环境。 有关详细信息,请参阅 Azure Cloud Shell 入门。
如需在本地运行 CLI 参考命令,请安装 Azure CLI。 如果在 Windows 或 macOS 上运行,请考虑在 Docker 容器中运行 Azure CLI。 有关详细信息,请参阅如何在 Docker 容器中运行 Azure CLI。
如果使用的是本地安装,请使用 az login 命令登录到 Azure CLI。 若要完成身份验证过程,请遵循终端中显示的步骤。 有关其他登录选项,请参阅 使用 Azure CLI 向 Azure 进行身份验证。
出现提示时,请在首次使用时安装 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 教程开始。
清理资源
可以使用 az group delete 命令在不需要资源组和 API 管理服务实例时将其删除。
az group delete --name myResourceGroup