Query Keys - List By Search Service

Tjänst:: Search Management

API-version:: 2023-11-01

Returnerar listan med fråge-API-nycklar för den angivna söktjänsten.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen i den aktuella prenumerationen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
searchServiceName	path	True	string	Namnet på söktjänsten som är associerad med den angivna resursgruppen.
subscriptionId	path	True	string	Den unika identifieraren för en Microsoft Azure-prenumeration. Du kan hämta det här värdet från Azure Resource Manager-API:et, kommandoradsverktygen eller portalen.
api-version	query	True	string	DEN API-version som ska användas för varje begäran.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	Ett klientgenererat GUID-värde som identifierar den här begäran. Om det anges inkluderas detta i svarsinformationen som ett sätt att spåra begäran.

Svar

Name	Typ	Description
200 OK	ListQueryKeysResult	Alla frågenycklar för den angivna söktjänsten har hämtats och finns i svaret. Du kan använda någon av frågenycklarna som värdet för parametern "api-key" i rest-API:et för dataplanet eller en Azure SDK för att utföra skrivskyddade åtgärder i dokumentsamlingen för dina sökindex, till exempel genom att fråga efter och leta upp dokument efter ID.
Other Status Codes	CloudError	HTTP 404 (hittades inte): Det gick inte att hitta prenumerationen, resursgruppen eller söktjänsten. HTTP 409 (konflikt): Den angivna prenumerationen är inaktiverad.

Säkerhet

azure_auth

Auktoriseringsflöde för Microsoft Entra ID OAuth2.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

SearchListQueryKeysBySearchService

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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>"
    }
  ]
}

Definitioner

Name	Description
CloudError	Innehåller information om ett API-fel.
CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
ListQueryKeysResult	Svar som innehåller fråge-API-nycklar för en viss söktjänst.
QueryKey	Beskriver en API-nyckel för en viss söktjänst som endast har behörighet för frågeåtgärder.

CloudError

Objekt

Innehåller information om ett API-fel.

Name	Typ	Description
error	CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.

CloudErrorBody

Objekt

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.
details	CloudErrorBody[]	Innehåller kapslade fel som är relaterade till det här felet.
message	string	Ett meddelande som beskriver felet i detalj och ger felsökningsinformation.
target	string	Målet för det specifika felet (till exempel namnet på egenskapen i fel).

ListQueryKeysResult

Objekt

Svar som innehåller fråge-API-nycklar för en viss söktjänst.

Name	Typ	Description
nextLink	string	Begär URL som kan användas för att fråga nästa sida med frågenycklar. Returneras när det totala antalet begärda frågenycklar överskrider den maximala sidstorleken.
value	QueryKey[]	Frågenycklarna för söktjänsten.

QueryKey

Objekt

Beskriver en API-nyckel för en viss söktjänst som endast har behörighet för frågeåtgärder.

Name	Typ	Description
key	string	Värdet för fråge-API-nyckeln.
name	string	Namnet på fråge-API-nyckeln; kan vara tom.