Query Keys - Create
指定した検索サービスの新しいクエリ キーを生成します。 サービスごとに最大 50 個のクエリ キーを作成できます。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}?api-version=2025-02-01-previewURI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
name
|
path | True |
string |
新しいクエリ API キーの名前。 |
|
resource
|
path | True |
string |
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。 |
|
search
|
path | True |
string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ |
指定したリソース グループに関連付けられている Azure AI Search サービスの名前。 |
|
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションの一意識別子。 この値は、Azure Resource Manager API またはポータルから取得できます。 |
|
api-version
|
query | True |
string |
各要求に使用する API バージョン。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
この要求を識別するクライアントによって生成される GUID 値。 指定した場合、これは要求を追跡する方法として応答情報に含まれます。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
クエリ キーが正常に作成され、応答内にあります。 Azure AI Search サービス REST API または SDK の 'api-key' パラメーターの値としてクエリ キーを使用して、ID によるドキュメントのクエリや検索などの検索インデックスに対して読み取り専用操作を実行できます。 |
|
| Other Status Codes |
HTTP 404 (見つかりません): サブスクリプション、リソース グループ、または検索サービスが見つかりませんでした。 HTTP 409 (競合): 指定されたサブスクリプションが無効になっています。 |
セキュリティ
azure_auth
Microsoft ID プラットフォームでサポートされている暗黙的な許可フローを指定します。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
SearchCreateQueryKey
要求のサンプル
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/An API key granting read-only access to the documents collection of an index.?api-version=2025-02-01-preview
応答のサンプル
{
"name": "An API key granting read-only access to the documents collection of an index.",
"key": "<a query API key>"
}定義
| 名前 | 説明 |
|---|---|
|
Cloud |
API エラーに関する情報が含まれています。 |
|
Cloud |
エラー コードとメッセージを含む特定の API エラーについて説明します。 |
|
Query |
インデックスのドキュメント コレクションに対する読み取り専用アクセス許可を伝達する、特定の Azure AI Search サービスの API キーについて説明します。 |
CloudError
API エラーに関する情報が含まれています。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー コードとメッセージを含む特定の API エラーについて説明します。 |
|
| message |
string |
問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。 |
CloudErrorBody
エラー コードとメッセージを含む特定の API エラーについて説明します。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
HTTP 状態コードよりも正確にエラー状態を記述するエラー コード。 特定のエラー ケースをプログラムで処理するために使用できます。 |
| details |
このエラーに関連する入れ子になったエラーが含まれています。 |
|
| message |
string |
エラーの詳細を説明し、デバッグ情報を提供するメッセージ。 |
| target |
string |
特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。 |
QueryKey
インデックスのドキュメント コレクションに対する読み取り専用アクセス許可を伝達する、特定の Azure AI Search サービスの API キーについて説明します。
| 名前 | 型 | 説明 |
|---|---|---|
| key |
string |
クエリ API キーの値。 |
| name |
string |
クエリ API キーの名前。 クエリ名は省略可能ですが、名前を割り当てると、その使用方法を覚えておくのに役立ちます。 |