Query Keys - List By Search Service

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

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

URI パラメーター

Name In Required Type Description
resourceGroupName
path True
  • string

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

searchServiceName
path True
  • string

指定されたリソースグループに関連付けられている Azure Cognitive Search サービスの名前。

subscriptionId
path True
  • string

Microsoft Azure サブスクリプションの一意の識別子。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

api-version
query True
  • string

各要求に使用する API バージョン。

要求ヘッダー

Name Required Type Description
x-ms-client-request-id
  • string
uuid

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

応答

Name Type Description
200 OK

指定された search サービスのすべてのクエリキーが正常に取得され、応答に含まれています。 Azure Cognitive Search Service REST API または SDK の "api キー" パラメーターの値としてクエリキーのいずれかを使用して、検索インデックス (ID によるドキュメントの照会と検索など) に対して読み取り専用操作を実行できます。

Other Status Codes

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

セキュリティ

azure_auth

Azure Active DirectoryOAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザーアカウントの権限を借用する

SearchListQueryKeysBySearchService

Sample Request

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

Sample Response

{
  "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

指定された Azure Cognitive Search サービスのクエリ API キーを含む応答。

QueryKey

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

CloudError

API エラーに関する情報を格納します。

Name Type Description
error

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

message
  • string

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

CloudErrorBody

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

Name Type Description
code
  • string

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

details

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

message
  • string

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

target
  • string

特定のエラーのターゲット (エラーのプロパティの名前など)。

ListQueryKeysResult

指定された Azure Cognitive Search サービスのクエリ API キーを含む応答。

Name Type Description
nextLink
  • string

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

value

Azure Cognitive Search サービスのクエリキー。

QueryKey

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

Name Type Description
key
  • string

クエリ API キーの値。

name
  • string

クエリ API キーの名前。空の場合もあります。