このパッケージには、Azure SearchManagement クライアント用の同型 SDK (Node.js とブラウザーの両方で実行されます) が含まれています。
Azure AI Search サービスと API キーの管理に使用できるクライアント。
ソースコード | パッケージ(NPM) | API リファレンス ドキュメント | サンプル
Getting started
現在サポートされている環境
- Node.js の LTS バージョン
- Safari、Chrome、Edge、Firefox の最新バージョン。
詳細については、 サポートポリシー を参照してください。
Prerequisites
@azure/arm-search
パッケージをインストールする
npm
を使用して JavaScript 用 Azure SearchManagement クライアント ライブラリをインストールします。
npm install @azure/arm-search
SearchManagementClient
を作成して認証する
Azure SearchManagement API にアクセスするためのクライアント オブジェクトを作成するには、Azure SearchManagement リソースとendpoint
のcredential
が必要です。 Azure SearchManagement クライアントは、Azure Active Directory 資格情報を使用して認証できます。
Azure SearchManagement リソースのエンドポイントは 、Azure Portal で確認できます。
Azure Active Directory では、 @azure/ID ライブラリの資格情報または 既存の AAD トークンを使用して認証できます。
次に示す 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");
ログを有効にする方法の詳細な手順については、 @azure/logger パッケージのドキュメントを参照してください。
Next steps
このライブラリの詳細な使用例については、 サンプル ディレクトリをご覧ください。
Contributing
このライブラリに貢献したい場合は、 コントリビューションガイド を読んで、コードのビルドとテストの方法の詳細を確認してください。
Related projects
- Microsoft Azure SDK for JavaScript の
Azure SDK for JavaScript