Query Keys - List By Search Service

Szolgáltatás:: Search Management

API-verzió:: 2026-11-01

Visszaadja a megadott Azure AI Keresés szolgáltatás lekérdezési API kulcsainak listáját.

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

URI-paraméterek

Név	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	A megadott erőforráscsoporthoz társított Azure AI Keresés szolgáltatás neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Név	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	Egy ügyfél által létrehozott GUID-érték, amely azonosítja ezt a kérést. Ha meg van adva, ez a kérés nyomon követésének módjaként szerepelni fog a válaszinformációkban.

Válaszok

Név	Típus	Description
200 OK	ListQueryKeysResult	Az Azure működése sikeresen befejeződött.
Other Status Codes	CloudError	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Név	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

SearchListQueryKeysBySearchService

Mintakérelem

HTTP

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

Mintaválasz

Állapotkó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>"
    }
  ]
}

Definíciók

Név	Description
CloudError	Api-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
ListQueryKeysResult	Adott Azure AI Keresés szolgáltatás lekérdezési API-kulcsait tartalmazó válasz.
QueryKey	Leír egy API kulcsot egy adott Azure AI Keresés szolgáltatáshoz, amely csak olvasható jogokat továbbít egy index docs gyűjteményéhez.

CloudError

Tárgy

Api-hibával kapcsolatos információkat tartalmaz.

Név	Típus	Description
error	CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
message	string	A hiba rövid leírása, amely arra utal, hogy mi történt (a részletekért/hibakeresési információkért tekintse meg a "error.message" tulajdonságot).

CloudErrorBody

Tárgy

Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.

Név	Típus	Description
code	string	Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon is kezelhet.
details	CloudErrorBody[]	Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
message	string	A hibát részletesen leíró és hibakeresési információkat tartalmazó üzenet.
target	string	Az adott hiba célja (például a hibás tulajdonság neve).

ListQueryKeysResult

Tárgy

Adott Azure AI Keresés szolgáltatás lekérdezési API-kulcsait tartalmazó válasz.

Név	Típus	Description
nextLink	string	Kérelem URL-címe, amely a lekérdezési kulcsok következő oldalának lekérdezéséhez használható. Akkor adja vissza, ha a kért lekérdezési kulcsok teljes száma meghaladja a maximális oldalméretet.
value	QueryKey[]	Az Azure AI Keresés szolgáltatás lekérdezési kulcsai.

QueryKey

Tárgy

Leír egy API kulcsot egy adott Azure AI Keresés szolgáltatáshoz, amely csak olvasható jogokat továbbít egy index docs gyűjteményéhez.

Név	Típus	Description
key	string	A lekérdezési API-kulcs értéke.
name	string	A lekérdezési API-kulcs neve. A lekérdezésnevek megadása nem kötelező, de a név hozzárendelése segíthet emlékezni a használatukra.