共用方式為

管理 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 參考頁面時，請從下拉式篩選條件中選取 API 版本。

版本選取器的螢幕快照。

許可權和訪問控制

管理權限通過 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 Command-Line 命令列介面（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