Megosztás a következőn keresztül:


Query Keys - List By Search Service

Az adott keresési szolgáltatás lekérdezési API-kulcsainak listáját adja vissza.

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

URI-paraméterek

Name In Kötelező Típus Description
resourceGroupName
path True

string

Az aktuális előfizetésen belüli erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.

searchServiceName
path True

string

A megadott erőforráscsoporthoz társított keresési szolgáltatás neve.

subscriptionId
path True

string

A Microsoft Azure-előfizetés egyedi azonosítója. Ezt az értéket az Azure Resource Manager API-ból, a parancssori eszközökből vagy a portálról szerezheti be.

api-version
query True

string

Az egyes kérésekhez használandó API-verzió.

Kérelem fejléce

Name 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

Name Típus Description
200 OK

ListQueryKeysResult

Az adott keresési szolgáltatás összes lekérdezési kulcsa sikeresen le lett kérve, és a válaszban szerepel. A lekérdezési kulcsok bármelyikét használhatja az "api-key" paraméter értékeként az adatsík REST API-jában vagy egy Azure SDK-ban, hogy írásvédett műveleteket hajtson végre a keresési indexek dokumentumgyűjteményén, például a dokumentumok azonosító alapján történő lekérdezéséhez és kereséséhez.

Other Status Codes

CloudError

HTTP 404 (Nem található): Az előfizetés, az erőforráscsoport vagy a keresési szolgáltatás nem található. HTTP 409 (ütközés): A megadott előfizetés le van tiltva.

Biztonság

azure_auth

Microsoft Entra ID OAuth2 engedélyezési folyamat.

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

Hatókörök

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

SearchListQueryKeysBySearchService

Mintakérelem

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

Mintaválasz

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

Name Description
CloudError

Egy API-hibával kapcsolatos információkat tartalmaz.

CloudErrorBody

Egy adott API-hibát ismertet hibakóddal és üzenettel.

ListQueryKeysResult

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

QueryKey

Egy olyan API-kulcsot ismertet egy adott keresési szolgáltatáshoz, amely csak lekérdezési műveletekhez rendelkezik engedélyekkel.

CloudError

Egy API-hibával kapcsolatos információkat tartalmaz.

Name Típus Description
error

CloudErrorBody

Egy adott API-hibát ismertet hibakóddal és üzenettel.

CloudErrorBody

Egy adott API-hibát ismertet hibakóddal és üzenettel.

Name Típus Description
code

string

Egy hibakód, amely pontosabban írja le a hibaállapotot, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon lehet kezelni.

details

CloudErrorBody[]

Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.

message

string

Egy üzenet, amely részletesen leírja a hibát, és hibakeresési információkat tartalmaz.

target

string

Az adott hiba célja (például a hibás tulajdonság neve).

ListQueryKeysResult

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

Name 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[]

A keresési szolgáltatás lekérdezési kulcsai.

QueryKey

Egy olyan API-kulcsot ismertet egy adott keresési szolgáltatáshoz, amely csak lekérdezési műveletekhez rendelkezik engedélyekkel.

Name Típus Description
key

string

A lekérdezési API-kulcs értéke.

name

string

A lekérdezési API-kulcs neve; lehet, hogy üres.