Query Keys - Create

Szolgáltatás:: Search Management

API-verzió:: 2024-03-01-preview

Létrehoz egy új lekérdezési kulcsot a megadott keresési szolgáltatáshoz. Szolgáltatásonként legfeljebb 50 lekérdezési kulcsot hozhat létre.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}?api-version=2024-03-01-preview

URI-paraméterek

Név	In	Kötelező	Típus	Description
name	path	True	string	Az új lekérdezési API-kulcs neve.
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 pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	A megadott erőforráscsoporthoz társított Azure AI Search 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 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

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	QueryKey	A lekérdezési kulcs létrehozása sikeresen megtörtént, és a válaszban szerepel. A lekérdezési kulcsot használhatja az "api-key" paraméter értékeként az Azure AI Search szolgáltatás REST API-jában vagy az SDK-ban, hogy írásvédett műveleteket hajtson végre a keresési indexeken, például a dokumentumok lekérdezését és keresését azonosító alapján.
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

Implicit engedélyezési folyamatot határoz meg a Microsoft Identity platformon támogatott módon.

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

SearchCreateQueryKey

Mintakérelem

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/An API key granting read-only access to the documents collection of an index.?api-version=2024-03-01-preview

Mintaválasz

Állapotkód:: 200

{
  "name": "An API key granting read-only access to the documents collection of an index.",
  "key": "<a 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.
QueryKey	Egy adott Azure AI Search szolgáltatás API-kulcsát ismerteti, amely írásvédett engedélyeket ad át egy index dokumentumgyű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 hiba tulajdonságának neve).

QueryKey

Tárgy

Egy adott Azure AI Search szolgáltatás API-kulcsát ismerteti, amely írásvédett engedélyeket ad át egy index dokumentumgyű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.