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