Query Keys - List By Search Service

Zwraca listę kluczy API zapytań dla danej usługi Wyszukiwanie AI platformy Azure.

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

Parametry identyfikatora URI

Nazwisko W Wymagane Typ Opis
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

searchServiceName
path True

string

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

Nazwa usługi Wyszukiwanie AI platformy Azure skojarzonej z określoną grupą zasobów.

subscriptionId
path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.

api-version
query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwisko Wymagane Typ Opis
x-ms-client-request-id

string (uuid)

Wartość identyfikatora GUID wygenerowana przez klienta, która identyfikuje to żądanie. Jeśli zostanie określony, zostanie to uwzględnione w informacjach o odpowiedzi jako sposób śledzenia żądania.

Odpowiedzi

Nazwisko Typ Opis
200 OK

ListQueryKeysResult

Operacja Azure zakończyła się pomyślnie.

Other Status Codes

CloudError

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwisko Opis
user_impersonation podszywaj się pod konto użytkownika

Przykłady

SearchListQueryKeysBySearchService

Przykładowe żądanie

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

Przykładowa odpowiedź

{
  "value": [
    {
      "name": "Query key for browser-based clients",
      "key": "<a query API key>"
    },
    {
      "name": "Query key for mobile clients",
      "key": "<another query API key>"
    }
  ]
}

Definicje

Nazwisko Opis
CloudError

Zawiera informacje o błędzie interfejsu API.

CloudErrorBody

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

ListQueryKeysResult

Odpowiedź zawierająca klucze interfejsu API zapytań dla danej usługi Wyszukiwanie AI platformy Azure.

QueryKey

Opisuje klucz API dla danej usługi Wyszukiwanie AI platformy Azure, który przekazuje uprawnienia tylko do odczytu w kolekcji dokumentacji indeksu.

CloudError

Zawiera informacje o błędzie interfejsu API.

Nazwisko Typ Opis
error

CloudErrorBody

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

message

string

Krótki opis błędu, który wskazuje, co poszło nie tak (aby uzyskać szczegółowe informacje/debugowanie, zapoznaj się z właściwością "error.message").

CloudErrorBody

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwisko Typ Opis
code

string

Kod błędu opisujący warunek błędu dokładniej niż kod stanu HTTP. Może służyć do programowego obsługi określonych przypadków błędów.

details

CloudErrorBody[]

Zawiera zagnieżdżone błędy związane z tym błędem.

message

string

Komunikat opisujący szczegółowo błąd i zawierający informacje o debugowaniu.

target

string

Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie).

ListQueryKeysResult

Odpowiedź zawierająca klucze interfejsu API zapytań dla danej usługi Wyszukiwanie AI platformy Azure.

Nazwisko Typ Opis
nextLink

string

Adres URL żądania, który może służyć do wykonywania zapytań względem następnej strony kluczy zapytań. Zwracane, gdy łączna liczba żądanych kluczy zapytania przekracza maksymalny rozmiar strony.

value

QueryKey[]

Klucze zapytań dla usługi Wyszukiwanie AI platformy Azure.

QueryKey

Opisuje klucz API dla danej usługi Wyszukiwanie AI platformy Azure, który przekazuje uprawnienia tylko do odczytu w kolekcji dokumentacji indeksu.

Nazwisko Typ Opis
key

string

Wartość klucza interfejsu API zapytania.

name

string

Nazwa klucza interfejsu API zapytania. Nazwy zapytań są opcjonalne, ale przypisywanie nazwy może ułatwić zapamiętanie sposobu jej użycia.