Query Keys - List By Search Service

  • リファレンス
Service:
Search Management
API Version:
2021-04-01-preview

指定された 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

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

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

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

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

Status code:
200 
{
  "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 キーの名前。は空である可能性があります。