次の方法で共有

JavaScript 用 Azure SearchManagement クライアント ライブラリ - バージョン 3.2.0

  • [アーティクル]

このパッケージには、Azure SearchManagement クライアント用の同型 SDK (Node.js とブラウザーの両方で実行されます) が含まれています。

Azure AI Search サービスと API キーの管理に使用できるクライアント。

ソースコード | パッケージ (NPM) | API リファレンス ドキュメント | サンプル

はじめに

現在サポートされている環境

詳細については、Microsoft のサポート ポリシーを参照してください。

前提条件

@azure/arm-search パッケージのインストール

を使用して、JavaScript 用の Azure SearchManagement クライアント ライブラリを npmインストールします。

npm install @azure/arm-search

SearchManagementClient を作成して認証する

Azure SearchManagement API にアクセスするためのクライアント オブジェクトを作成するには、Azure SearchManagement リソースの と credentialが必要endpointです。 Azure SearchManagement クライアントは、Azure Active Directory 資格情報を使用して認証できます。 Azure SearchManagement リソースのエンドポイントは 、Azure Portal で確認できます。

@azure/ID ライブラリまたは既存の AAD トークンからの資格情報を使用して、Azure Active Directory で認証できます。

下に示した DefaultAzureCredential プロバイダーか、Azure SDK で提供されている他の資格情報プロバイダーを使用するには、@azure/identity パッケージをインストールしてください。

npm install @azure/identity

また、 新しい AAD アプリケーションを登録し 、適切なロールをサービス プリンシパルに割り当てて Azure SearchManagement へのアクセス権を付与する必要があります (注: などの "Owner" ロールは、必要なアクセス許可を付与しません)。 環境変数として、AAD アプリケーションのクライアント ID、テナント ID、およびクライアント シークレットの値を設定します。 AZURE_CLIENT_IDAZURE_TENANT_IDAZURE_CLIENT_SECRET

Azure AD アプリケーションを作成する方法の詳細については、このガイドをチェック。

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new SearchManagementClient(new DefaultAzureCredential(), subscriptionId);

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
//   tenantId: "<YOUR_TENANT_ID>",
//   clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new SearchManagementClient(credential, subscriptionId);

JavaScript バンドル

ブラウザーでこのクライアント ライブラリを使用するには、まず bundler を使用する必要があります。 これを行う方法の詳細については、 バンドルに関するドキュメントを参照してください。

主要な概念

SearchManagementClient

SearchManagementClient は、Azure SearchManagement クライアント ライブラリを使用する開発者向けの主要なインターフェイスです。 このクライアント オブジェクトのメソッドを調べて、アクセスできる Azure SearchManagement サービスのさまざまな機能を理解します。

トラブルシューティング

ログ記録

ログの記録を有効にすると、エラーに関する有用な情報を明らかにするのに役立つ場合があります。 HTTP 要求と応答のログを表示するには、環境変数 AZURE_LOG_LEVEL を info に設定します。 または、@azure/logger で setLogLevel を呼び出して、実行時にログ記録を有効にすることもできます。

const { setLogLevel } = require("@azure/logger");
setLogLevel("info");

ログを有効にする方法の詳細については、@azure/logger パッケージに関するドキュメントを参照してください。

次の手順

このライブラリの使用方法の詳細な例については、 サンプル ディレクトリを参照してください。

共同作成

このライブラリに投稿する場合、コードをビルドしてテストする方法の詳細については、投稿ガイドを参照してください。

インプレッション数