次の方法で共有


Query Keys - List By Search Service

指定された検索サービスのクエリ API キーの一覧を返します。

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

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

searchServiceName
path True

string

指定したリソース グループに関連付けられている検索サービスの名前。

subscriptionId
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

ListQueryKeysResult

指定された検索サービスのすべてのクエリ キーが正常に取得され、応答中です。 データ プレーン REST API または Azure SDK の 'api-key' パラメーターの値として、クエリ キーを使用して、ID によるドキュメントのクエリや検索などの検索インデックスのドキュメント コレクションに対して読み取り専用操作を実行できます。

Other Status Codes

CloudError

HTTP 404 (見つかりません): サブスクリプション、リソース グループ、または検索サービスが見つかりませんでした。 HTTP 409 (競合): 指定されたサブスクリプションが無効になっています。

セキュリティ

azure_auth

OAuth2 承認フローをMicrosoft Entra IDします。

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

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

SearchListQueryKeysBySearchService

要求のサンプル

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listQueryKeys?api-version=2023-11-01

応答のサンプル

{
  "value": [
    {
      "name": "Query key for browser-based clients",
      "key": "<a query API key>"
    },
    {
      "name": "Query key for mobile clients",
      "key": "<another query API key>"
    }
  ]
}

定義

名前 説明
CloudError

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

CloudErrorBody

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

ListQueryKeysResult

特定の検索サービスのクエリ API キーを含む応答。

QueryKey

クエリ操作専用のアクセス許可を持つ特定の検索サービスの API キーについて説明します。

CloudError

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

名前 説明
error

CloudErrorBody

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

CloudErrorBody

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

名前 説明
code

string

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

details

CloudErrorBody[]

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

message

string

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

target

string

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

ListQueryKeysResult

特定の検索サービスのクエリ API キーを含む応答。

名前 説明
nextLink

string

クエリ キーの次のページのクエリに使用できる要求 URL。 要求されたクエリ キーの合計数が最大ページ サイズを超えた場合に返されます。

value

QueryKey[]

検索サービスのクエリ キー。

QueryKey

クエリ操作専用のアクセス許可を持つ特定の検索サービスの API キーについて説明します。

名前 説明
key

string

クエリ API キーの値。

name

string

クエリ API キーの名前。は空である可能性があります。