Azure AI 搜尋) (管理 REST API 參考

  • 發行項

Azure AI 搜尋 的管理 REST API (先前稱為 Azure 認知搜尋) 提供系統管理作業的程式設計存取：

  • 建立、更新和刪除搜尋服務
  • 擷取搜尋服務資訊
  • 建立、重新產生或擷取 api-keys (查詢或系統管理員密鑰)
  • 新增或移除複本和分割區， (調整容量)
  • 設定搜尋服務以使用私人端點
  • 啟用或停用 Azure 角色型訪問控制

對於數據平面工作，例如建立和查詢索引，請改用 搜尋 服務 REST API。

如何使用管理 REST API

若要以程式設計方式完全管理服務，您可以使用兩個 API：此處記載的 Azure AI 管理 REST API 搜尋，以及常見的 Azure Resource Manager REST API。

Resource Manager API 用於非特定服務的一般用途作業，例如查詢訂用帳戶數據、列出地理位置等等。 所有 Resource Manager API 呼叫都會使用 Microsoft Entra ID 進行驗證。 您必須在 Microsoft Entra 租用戶中擁有成員資格和角色指派，才能進行 Resource Manager API 呼叫。

版本化 API 檔

REST API 檔現在已設定版本。 當您開啟 API 參考頁面時，請從下拉式篩選條件中選取 API 版本。

版本選取器的螢幕快照。

權限和存取控制

系統管理許可權會透過 Microsoft Entra ID 中的內建角色來傳達：

  • 大部分的工作都需要擁有者或參與者指派。
  • 除了需要擁有者或參與者) 許可權的 API 金鑰以外，讀取者角色對 GET 作業 (服務資訊的存取權有限。

如需詳細資訊，請參閱 Azure AI 中的角色型訪問控制 搜尋。

最佳做法是將角色指派給群組，而不是個別使用者。 Azure 訂用帳戶擁有者或全域管理員會管理這些指派。 如需詳細資訊，請參閱將 Microsoft Entra 角色指派給群組。

線上到管理端點

設定連線時，請從 Resource Manager 端點https://management.azure.com開始，然後新增訂用帳戶標識碼、提供者 () Microsoft.Search 和 API 版本。 作業是在要求的主體中指定。

完整指定的端點具有下列元件：

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

下列用戶端通常用來呼叫管理 REST API：

用戶端 指示和範例
使用 Az.搜尋 模組 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 會依個別發行排程獨立更新：

另請參閱