Query Keys - Create

Vygeneruje nový klíč dotazu pro zadanou vyhledávací službu. Pro každou službu můžete vytvořit až 50 klíčů dotazů.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
name
path True

string

Název nového klíče rozhraní API pro dotazy.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

searchServiceName
path True

string

pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

Název služby Azure AI Search přidružené k zadané skupině prostředků.

subscriptionId
path True

string (uuid)

ID cílového předplatného. Hodnota musí být UUID.

api-version
query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name 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

Name Typ Description
200 OK

QueryKey

Operace Azure byla úspěšně dokončena.

Other Status Codes

CloudError

Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

SearchCreateQueryKey

Ukázkový požadavek

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

Ukázková odpověď

{
  "name": "An API key granting read-only access to the documents collection of an index.",
  "key": "<a query API key>"
}

Definice

Name Description
CloudError

Obsahuje informace o chybě rozhraní API.

CloudErrorBody

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

QueryKey

Popisuje klíč rozhraní API pro danou službu Azure AI Search, která vyjadřuje oprávnění jen pro čtení v kolekci dokumentů indexu.

CloudError

Obsahuje informace o chybě rozhraní API.

Name Typ Description
error

CloudErrorBody

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

message

string

Stručný popis chyby, která naznačuje, co se nepovedlo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message).

CloudErrorBody

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

Name 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ě).

QueryKey

Popisuje klíč rozhraní API pro danou službu Azure AI Search, která vyjadřuje oprávnění jen pro čtení v kolekci dokumentů indexu.

Name Typ Description
key

string

Hodnota klíče rozhraní API dotazu.

name

string

Název klíče rozhraní API dotazu. Názvy dotazů jsou volitelné, ale přiřazení názvu vám může pomoct zapamatovat si, jak se používá.