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

在 Azure API 管理中创建订阅

适用于:所有 API 管理层级

通过 Azure API 管理发布 API 时,常见的简单做法是使用订阅密钥保护对这些 API 的访问。 需使用已发布 API 的客户端应用程序调用这些 API 时必须在 HTTP 请求中包括一个有效的订阅密钥。 若要获取访问 API 所需的订阅密钥,必须拥有订阅。 有关订阅的详细信息,请参阅 Azure API 管理中的订阅

本文演示如何在 Azure 门户中创建订阅。

先决条件

若要执行本文中的步骤,必须具备以下先决条件:

创建新订阅

  1. Azure 门户中导航到自己的 API 管理实例。

  2. 在左侧菜单“API”下,选择“订阅”>“添加订阅”。

  3. 提供订阅的“名称”和可选的“显示名称”。

  4. (可选)选择“允许跟踪”来启用跟踪以调试 API 并对其进行故障排除。 了解详细信息

    警告

    • 仅允许跟踪用于调试目的的订阅。 与未经授权的用户共享允许跟踪的订阅密钥,可能会导致跟踪日志中包含的敏感信息泄露,例如密钥、访问令牌、密码、内部主机名和 IP 地址。
    • 在测试控制台中,在订阅上启用跟踪 1 小时后,API 管理会自动禁用跟踪。

    注意

    目前,基本 v2 层级和标准 v2 层级不支持 API 请求跟踪。

  5. 从下拉列表中选择订阅的“范围”。 了解详细信息

  6. (可选)选择订阅是否应与用户关联,以及是否发送用于开发人员门户的通知。

  7. 选择“创建”。

屏幕截图显示了如何在门户中创建 API 管理订阅。

创建订阅后,它会出现在“订阅”页面的列表中。 提供了两个用于访问 API 的 API 密钥。 一个主密钥,一个辅助密钥。

后续步骤

获取有关 API 管理的详细信息: