Query Keys - Delete

指定したクエリ キーを削除します。 管理者キーとは異なり、クエリ キーは再生成されません。 クエリ キーを再生成するプロセスは、削除してから再作成することです。 削除に成功すると200(OK)、サービスが存在するがクエリキーが見つからない場合は204(コンテンツなし)、サービスが見つからない場合は404(未発見)を返します。 注:404の返却の行動はARMガイドラインと一致しません。 クライアントは今後のバージョンで204応答を期待し、404応答への新たな依存を避けるべきです。

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}?api-version=2025-05-01

URI パラメーター

名前 / 必須 型 説明
key
path True

string

削除するクエリ キー。 クエリ キーは、名前ではなく値によって識別されます。

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 Search サービスの名前。

subscriptionId
path True

string (uuid)

ターゲット サブスクリプションの ID。 値は UUID である必要があります。

api-version
query True

string

minLength: 1

この操作に使用する API バージョン。

要求ヘッダー

名前 必須 型 説明
x-ms-client-request-id

string (uuid)

この要求を識別するクライアントによって生成される GUID 値。 指定した場合、これは要求を追跡する方法として応答情報に含まれます。

応答

名前 型 説明
200 OK

要求は成功しました。

204 No Content

この要求に送信するコンテンツはありませんが、ヘッダーが役立つ場合があります。

404 Not Found

サーバーは、要求されたリソースを見つけることができません。

Other Status Codes

CloudError

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

例

SearchDeleteQueryKey

要求のサンプル

DELETE https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/deleteQueryKey/<a query API key>?api-version=2025-05-01

応答のサンプル

定義

名前 説明
CloudError

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

CloudErrorBody

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

CloudError

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

名前 型 説明
error

CloudErrorBody

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

message

string

問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。

CloudErrorBody

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

名前 型 説明
code

string

HTTP 状態コードよりも正確にエラー状態を記述するエラー コード。 特定のエラー ケースをプログラムで処理するために使用できます。

details

CloudErrorBody[]

このエラーに関連する入れ子になったエラーが含まれています。

message

string

エラーの詳細を説明し、デバッグ情報を提供するメッセージ。

target

string

特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。