Query Keys - Create

Service:: Search Management

API バージョン:: 2026-11-01

指定した検索サービスの新しいクエリキーを生成します。サービスごとに最大 50 個のクエリキーを作成できます。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}?api-version=2026-11-01

URI パラメーター

Name	/	必須	型	説明
name	path	True	string	新しいクエリ API キーの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字を区別しません。
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	指定したリソースグループに関連付けられているAzure AI 検索サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

Name	必須	型	説明
x-ms-client-request-id		string (uuid)	この要求を識別するクライアントによって生成される GUID 値。指定した場合、これは要求を追跡する方法として応答情報に含まれます。

応答

Name	型	説明
200 OK	QueryKey	Azureの運用は無事に完了しました。
Other Status Codes	CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

Name	説明
user_impersonation	あなたのユーザーアカウントになりすます

例

SearchCreateQueryKey

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/An API key granting read-only access to the documents collection of an index.?api-version=2026-11-01

応答のサンプル

状態コード:: 200

{
  "name": "An API key granting read-only access to the documents collection of an index.",
  "key": "<a query API key>"
}

定義

Name	説明
CloudError	API エラーに関する情報が含まれています。
CloudErrorBody	エラーコードとメッセージを含む特定の API エラーについて説明します。
QueryKey	特定のAzure AI 検索サービスに対して、インデックスのドキュメントコレクションに対して読み取り専用権限を伝えるAPIキーを記述します。

CloudError

Object

API エラーに関する情報が含まれています。

Name	型	説明
error	CloudErrorBody	エラーコードとメッセージを含む特定の API エラーについて説明します。
message	string	問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。

CloudErrorBody

Object

エラーコードとメッセージを含む特定の API エラーについて説明します。

Name	型	説明
code	string	HTTP 状態コードよりも正確にエラー状態を記述するエラーコード。特定のエラーケースをプログラムで処理するために使用できます。
details	CloudErrorBody[]	このエラーに関連する入れ子になったエラーが含まれています。
message	string	エラーの詳細を説明し、デバッグ情報を提供するメッセージ。
target	string	特定のエラーのターゲット (たとえば、エラーのあるプロパティの名前)。

QueryKey

Object

特定のAzure AI 検索サービスに対して、インデックスのドキュメントコレクションに対して読み取り専用権限を伝えるAPIキーを記述します。

Name	型	説明
key	string	クエリ API キーの値。
name	string	クエリ API キーの名前。クエリ名は省略可能ですが、名前を割り当てると、その使用方法を覚えておくのに役立ちます。