Query Keys - List By Search Service

Služba:: Search Management

Verze rozhraní API:: 2023-11-01

Vrátí seznam klíčů rozhraní API dotazu pro danou vyhledávací službu.

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

Parametry identifikátoru URI

Název	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
searchServiceName	path	True	string	Název vyhledávací služby přidružené k zadané skupině prostředků.
subscriptionId	path	True	string	Jedinečný identifikátor předplatného Microsoft Azure. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru, nástrojů příkazového řádku nebo portálu.
api-version	query	True	string	Verze rozhraní API, která se má použít pro každý požadavek.

Hlavička požadavku

Název	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	Hodnota GUID vygenerovaná klientem, která identifikuje tento požadavek. Pokud je zadáno, budou tyto informace zahrnuty do informací o odpovědích jako způsob, jak sledovat požadavek.

Odpovědi

Název	Typ	Description
200 OK	ListQueryKeysResult	Všechny klíče dotazu pro danou vyhledávací službu byly úspěšně načteny a jsou v odpovědi. Jako hodnotu parametru api-key v rozhraní REST API roviny dat nebo v sadě Azure SDK můžete použít libovolný z klíčů dotazu k provádění operací jen pro čtení v kolekci vyhledávacích indexů, jako je dotazování a vyhledávání dokumentů podle ID.
Other Status Codes	CloudError	HTTP 404 (Nenalezena): Nepodařilo se najít předplatné, skupinu prostředků nebo vyhledávací službu. HTTP 409 (konflikt): Zadané předplatné je zakázané.

Zabezpečení

azure_auth

Tok autorizace Microsoft Entra ID OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Název	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

SearchListQueryKeysBySearchService

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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>"
    }
  ]
}

Definice

Název	Description
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
ListQueryKeysResult	Odpověď obsahující klíče rozhraní API dotazu pro danou vyhledávací službu
QueryKey	Popisuje klíč rozhraní API pro danou vyhledávací službu, která má oprávnění pouze pro operace dotazů.

CloudError

Objekt

Obsahuje informace o chybě rozhraní API.

Název	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

CloudErrorBody

Objekt

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Název	Typ	Description
code	string	Kód chyby, který popisuje chybový stav přesněji než stavový kód HTTP. Dá se použít k programovému zpracování konkrétních případů chyb.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které souvisejí s touto chybou.
message	string	Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě).

ListQueryKeysResult

Objekt

Odpověď obsahující klíče rozhraní API dotazu pro danou vyhledávací službu

Název	Typ	Description
nextLink	string	Adresa URL požadavku, která se dá použít k dotazování na další stránku klíčů dotazu. Vrátí se, když celkový počet požadovaných klíčů dotazu překročí maximální velikost stránky.
value	QueryKey[]	Klíče dotazu pro vyhledávací službu.

QueryKey

Objekt

Popisuje klíč rozhraní API pro danou vyhledávací službu, která má oprávnění pouze pro operace dotazů.

Název	Typ	Description
key	string	Hodnota klíče rozhraní API dotazu.
name	string	Název klíče rozhraní API dotazu; může být prázdný.