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

管理 REST API 参考 （Azure AI 搜索）

Azure AI 搜索（以前称为 Azure 认知搜索）的管理 REST API 提供对管理作的编程访问：

  • 创建、更新和删除搜索服务
  • 检索搜索服务信息
  • 创建、重新生成或检索 api-keys （查询或管理密钥）
  • 添加或删除副本和分区（调整容量）
  • 将搜索服务配置为使用专用终结点
  • 启用或禁用 Azure 基于角色的访问控制

对于数据平面任务（例如创建和查询索引），请改用 搜索服务 REST API 。

如何使用管理 REST API

若要以编程方式完全管理服务，可以使用两个 API：此处记录的 Azure AI 搜索的管理 REST API，以及通用 的 Azure 资源管理器 REST API。

资源管理器 API 用于非特定于服务的常规用途作，例如查询订阅数据、列出地理位置等。 所有资源管理器 API 调用均使用 Microsoft Entra ID 进行身份验证。 必须在 Microsoft Entra 租户中具有成员身份和角色分配才能进行资源管理器 API 调用。

版本控制 API 文档

REST API 文档已版本控制。 打开 API 参考页时，版本选择器将显示在目录上方。 当你从Reference > 资源管理器文件夹中选择页面时，选择器就会开放。

版本选择器的屏幕截图。

权限和访问控制

管理权限通过 Microsoft Entra ID 中的内置角色传达：

  • 大多数任务都需要所有者或参与者分配。
  • 读取者 角色对服务信息的访问权限有限（GET作，API 密钥除外，API 密钥需要所有者或参与者权限）。

有关详细信息，请参阅 Azure AI 搜索中基于角色的访问控制。

最佳做法是将角色分配给组而不是单个用户。 Azure 订阅所有者或全局管理员管理这些分配。 有关详细信息，请参阅 将 Microsoft Entra 角色分配给组。

连接到管理终结点

设置连接时，请从资源管理器终结点 https://management.azure.com 开始，然后添加订阅 ID、提供程序 （Microsoft.Search） 和 API 版本。 作在请求正文中指定。

完全指定的终结点具有以下组件：

https://management.azure.com/subscriptions/[subscriptionId]/resourceGroups/[resourceGroupName]/providers/Microsoft.Search/searchServices/[serviceName]?api-version=2020-08-01

以下客户端通常用于调用管理 REST API：

客户 说明和示例
使用 Az.Search 模块的 Azure PowerShell 使用 Azure PowerShell 管理 Azure AI 搜索
Azure 命令行接口 (CLI) 使用 Azure CLI 管理 Azure AI 搜索
包含 REST 客户端的 Visual Studio Code 使用 REST 管理 Azure AI 搜索

还可以 使用 Azure 门户管理搜索服务。

其他 SDK 中的管理 API

REST API 是 Azure AI 搜索的基础，对编程模型的任何更改都会首先反映在 REST API 中。

替代方法包括以下 Azure SDK，这些 SDK 按单独的发布计划独立更新：

另请参阅

  • Last updated on