Azure AI Search の管理 REST API (旧称 Azure Cognitive Search) は、管理操作へのプログラムによるアクセスを提供します。
- 検索サービスの作成、更新、削除
- 検索サービス情報の取得
-
api-keys(クエリまたは管理キー) の作成、再生成、または取得 - レプリカとパーティションの追加または削除 (容量の調整)
- プライベート エンドポイントを使用するように検索サービスを構成する
- Azure ロールベースのアクセス制御を有効または無効にする
インデックスの作成やクエリなどのデータ プレーン タスクの場合は、代わりに Search Service REST API を使用します。
管理 REST API の操作方法
プログラムでサービスを完全に管理するには、ここで説明する Azure AI Search の管理 REST API と、一般的な Azure Resource Manager REST API の 2 つの API を使用します。
Resource Manager API は、サブスクリプション データのクエリ、地理的な場所の一覧表示など、サービス固有ではない汎用操作に使用されます。 すべての Resource Manager API 呼び出しは、Microsoft Entra ID を使用して認証されます。 Resource Manager API 呼び出しを行うには、Microsoft Entra テナントにメンバーシップとロールの割り当てが必要です。
バージョン管理された API ドキュメント
REST API ドキュメントはバージョン管理されています。 API リファレンス ページを開いたら、ドロップダウン フィルターから API バージョンを選択します。
アクセス許可とアクセス制御
管理権限は、Microsoft Entra ID の組み込みロールを通じて伝達されます。
- 所有者 または 共同作成者の 割り当ては、ほとんどのタスクに必要です。
- 閲覧者ロールは 、サービス情報へのアクセスが制限されています (GET 操作、所有者または共同作成者のアクセス許可を必要とする API キーを除く)。
詳細については、「 Azure AI Search でのロールベースのアクセス制御」を参照してください。
ベストプラクティスは、個々のユーザーではなくグループにロールを割り当てることです。 Azure サブスクリプションの所有者またはグローバル管理者が、これらの割り当てを管理します。 詳細については、「 Microsoft Entra ロールをグループに割り当てる」を参照してください。
管理エンドポイントに接続する
接続を設定するときは、Resource Manager エンドポイント 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 の呼び出しには、次のクライアントが一般的に使用されます。
Azure portal を使用して検索サービスを管理することもできます。
他の SDK の管理 API
REST API は Azure AI Search の基盤であり、プログラミング モデルへの変更は最初に REST API に反映されます。
代替手段には、個別のリリース スケジュールで個別に更新される次の Azure SDK があります。
- .NET 用の Microsoft Azure AI Search 管理クライアント ライブラリ
- Python 用 Microsoft Azure SDK
- JavaScript 用の Azure Search Management クライアント ライブラリ
- Azure Resource Manager Java 用 Azure AI Search クライアント ライブラリ