Udostępnij za pośrednictwem


Query Keys - List By Search Service

Zwraca listę kluczy interfejsu API zapytań dla danej usługi wyszukiwania.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys?api-version=2023-11-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

Nazwa usługi wyszukiwania 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, narzędzi wiersza polecenia 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 odpowiedzi jako sposób śledzenia żądania.

Odpowiedzi

Nazwa Typ Opis
200 OK

ListQueryKeysResult

Wszystkie klucze zapytania 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 płaszczyzny danych lub zestawu Azure SDK do wykonywania operacji tylko do odczytu na kolekcji dokumentów indeksów 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

Tożsamość Microsoft Entra przepływ autoryzacji OAuth2.

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

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listQueryKeys?api-version=2023-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

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 zapytania dla danej usługi wyszukiwania.

QueryKey

Opisuje klucz interfejsu API dla danej usługi wyszukiwania, która ma uprawnienia tylko do operacji zapytań.

CloudError

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.

CloudErrorBody

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

Odpowiedź zawierająca klucze interfejsu API zapytania dla danej usługi wyszukiwania.

Nazwa Typ Opis
nextLink

string

Adres URL żądania, którego można użyć do wysyłania zapytań do następnej strony kluczy zapytań. Zwracane, gdy łączna liczba żądanych kluczy zapytania przekracza maksymalny rozmiar strony.

value

QueryKey[]

Klucze zapytań dla usługi wyszukiwania.

QueryKey

Opisuje klucz interfejsu API dla danej usługi wyszukiwania, która ma uprawnienia tylko do operacji zapytań.

Nazwa Typ Opis
key

string

Wartość klucza interfejsu API zapytania.

name

string

Nazwa klucza interfejsu API zapytania; może być pusta.