此套件包含 Azure SearchManagement 用戶端的同型 SDK(在 Node.js 和瀏覽器中執行)。
可用來管理 Azure AI 搜尋服務和 API 金鑰的用戶端。
原始程式碼 | 封裝 (NPM) | API 參考文件 | 樣品
Getting started
目前支援的環境
- LTS 版本的 Node.js
- 最新版的 Safari、Chrome、Edge 和 Firefox。
如需詳細資訊,請參閱我們的支援原則。
Prerequisites
安裝 @azure/arm-search 套件
使用 npm安裝適用於 JavaScript 的 Azure SearchManagement 用戶端連結庫:
npm install @azure/arm-search
建立和驗證 SearchManagementClient
若要建立客戶端物件來存取 Azure SearchManagement API,您需要 endpoint Azure SearchManagement 資源和 credential。 Azure SearchManagement 用戶端可以使用 Azure Active Directory 認證進行驗證。
您可以在 Azure 入口網站中找到 Azure SearchManagement 資源的端點。
可以使用 @azure/標識 庫中的憑據或 現有 AAD 令牌向 Azure Active Directory 進行身份驗證。
若要使用下面顯示的 DefaultAzureCredential 提供程式或隨 Azure SDK 提供的其他憑據提供程式,請安裝該 @azure/identity 包:
npm install @azure/identity
您也必須 註冊新的 AAD 應用程式,並將 適當的角色指派給服務主體,以授與 Azure SearchManagement 的存取權(注意:例如 "Owner" 的角色不會授與必要的許可權)。
有關如何創建 Azure AD 應用程式的詳細資訊,請查看 本指南。
使用 Node.js 和類似節點的環境,您可以使用 DefaultAzureCredential 類別來驗證用戶端。
import { SearchManagementClient } from "@azure/arm-search";
import { DefaultAzureCredential } from "@azure/identity";
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new SearchManagementClient(new DefaultAzureCredential(), subscriptionId);
針對瀏覽器環境,請使用來自 InteractiveBrowserCredential 套件的 @azure/identity 進行驗證。
import { InteractiveBrowserCredential } from "@azure/identity";
import { SearchManagementClient } from "@azure/arm-search";
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
const client = new SearchManagementClient(credential, subscriptionId);
JavaScript Bundle
若要在瀏覽器中使用此用戶端連結庫,您必須先使用配套程式。 有關如何執行此作的詳細資訊,請參閱我們的 捆綁文檔。
Key concepts
SearchManagementClient
SearchManagementClient 是開發人員使用 Azure SearchManagement 用戶端連結庫的主要介面。 探索此客戶端物件上的方法,以瞭解您可以存取之 Azure SearchManagement 服務的不同功能。
Troubleshooting
Logging
啟用記錄可能有助於找出有關失敗的實用資訊。 若要查看 HTTP 要求和回應的記錄,請將 AZURE_LOG_LEVEL 環境變數設定為 info。 或者,您可以在運行時間啟用記錄,方法是在 setLogLevel中呼叫 @azure/logger:
import { setLogLevel } from "@azure/logger";
setLogLevel("info");
如需如何啟用記錄的詳細指示,請參閱
Next steps
請查看 範例 目錄,瞭解如何使用此庫的詳細範例。
Contributing
如果您想為該庫做出貢獻,請閱讀 貢獻指南 以瞭解有關如何構建和測試代碼的更多資訊。