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

直接管理API 管理 REST API

  • 项目

Azure API 管理提供直接管理 REST API，用于对所选实体（例如用户、组、产品和订阅）执行操作。 直接管理 API 可以绕过基于 Azure 资源管理器 API 的某些限制，例如请求限制。

重要

本部分介绍如何访问 REST API API 管理直接管理。 此 API 的身份验证机制与 Azure 资源管理器不同，并且使用不同的基 URL。

启用对直接管理 REST API 的访问

必须先授予对直接管理API 管理 REST API 的访问权限，然后才能成功调用。

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

  2. 从左侧菜单的“部署 + 基础结构”部分选择“管理 API”。

    在Azure 门户中选择“管理 API”

  3. 在“启用API 管理 REST API”中，选择“是”。

    重要

    如果未选择“启用API 管理 REST API”，则对该服务实例的 REST API 的调用将失败。

    在 Azure 门户 中启用 API 管理 API

默认媒体类型

请求和响应的默认媒体类型是 application/json。 某些操作支持其他内容类型，本主题将对此加以说明。 如果没有提到特定的操作支持其他内容类型，则媒体类型为 application/json。

身份验证

对 API 管理 REST API 的每个请求都必须附带一个Authorization包含有效共享访问令牌的标头，如以下示例所示。

Authorization: SharedAccessSignature uid=53dd860e1b72ff0467030003&ex=2014-08-04T22:03:00.0000000Z&sn=ItH6scUyCazNKHULKA0Yv6T+Skk4bdVmLqcPPPdWoxl2n1+rVbhKlplFrqjkoUFRr0og4wjeDz4yfThC82OjfQ==

可以通过编程方式生成此访问令牌，也可以在 API 管理发布者门户中生成。 有关生成和检索访问令牌的说明，请参阅 手动创建访问令牌 和 以编程方式创建访问令牌。

基 URL

直接管理API 管理 REST API 的基 URL 符合以下模板。

https://{servicename}.management.azure-api.net

此模板包含以下参数。

  • {serviceName} 是在创建服务期间指定的服务名称，例如 https://contosoapi.management.azure-api.net。

API 管理 REST API 返回的所有 URL 都相对于此基 URL，并且对 REST API 的所有请求都必须使用此基 URL 模板。

版本查询参数

应该为所有操作提供一个 api-version 查询参数，该参数的值采用 YYYY-MM-DD 格式，例如 2021-08-01。

注意

在API 管理 REST API 的预览期间，-preview会追加到版本查询参数，例如 2021-04-01-preview。

如果未在请求的查询字符串中传递此查询参数，则服务器将返回状态代码 400 Bad Request。 有关支持的版本列表，请参阅API 管理 REST API 参考。

后续步骤