Query Keys - List By Search Service

Usługa:

Search Management

Wersja interfejsu API:

2025-05-01

Zwraca listę kluczy interfejsu API zapytań dla danej usługi Azure AI Search.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach bieżącej subskrypcji. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nazwa usługi Azure AI Search skojarzonej z określoną grupą zasobów.
subscriptionId	path	True	string	Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
api-version	query	True	string	Wersja interfejsu API do użycia dla każdego żądania.

Nagłówek żądania

Nazwa	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

Nazwa	Typ	Opis
200 OK	ListQueryKeysResult	Wszystkie klucze zapytań dla danej usługi wyszukiwania zostały pomyślnie pobrane i znajdują się w odpowiedzi. Możesz użyć dowolnego klucza zapytania jako wartości parametru "api-key" w interfejsie API REST usługi Azure AI Search Service lub zestawu SDK do wykonywania operacji tylko do odczytu na indeksach wyszukiwania, takich jak wykonywanie zapytań i wyszukiwanie dokumentów według identyfikatora.
Other Status Codes	CloudError	HTTP 404 (Nie znaleziono): nie można odnaleźć subskrypcji, grupy zasobów lub usługi wyszukiwania. HTTP 409 (konflikt): określona subskrypcja jest wyłączona.

Zabezpieczenia

azure_auth

Określa niejawny przepływ udzielania, obsługiwany na platformie Microsoft Identity.

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

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

SearchListQueryKeysBySearchService

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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>"
    }
  ]
}

Definicje

Nazwa	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 Azure AI Search.
QueryKey	Opisuje klucz interfejsu API dla danej usługi Azure AI Search, która przekazuje uprawnienia tylko do odczytu w kolekcji dokumentacji indeksu.

CloudError

Objekt

Zawiera informacje o błędzie interfejsu API.

Nazwa	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

Objekt

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

Nazwa	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

Objekt

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

Nazwa	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 Azure AI Search.

QueryKey

Objekt

Opisuje klucz interfejsu API dla danej usługi Azure AI Search, która przekazuje uprawnienia tylko do odczytu w kolekcji dokumentacji indeksu.

Nazwa	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.