Udostępnij za pośrednictwem


Admin Keys - Get

Pobiera podstawowe i pomocnicze klucze interfejsu API administratora dla określonej usługi wyszukiwania.

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

AdminKeyResult

Klucze administratora zostały pomyślnie pobrane i znajdują się w odpowiedzi. Możesz użyć klucza podstawowego lub pomocniczego jako wartości parametru "api-key" w interfejsie API REST płaszczyzny danych lub zestawu SDK platformy Azure do wykonywania dowolnych operacji w usłudze wyszukiwania, w tym operacji uprzywilejowanych. Operacje uprzywilejowane obejmują zarządzanie zasobami, takimi jak indeksy i źródła danych, a także przekazywanie, modyfikowanie lub usuwanie danych w indeksach.

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

SearchGetAdminKeys

Przykładowe żądanie

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listAdminKeys?api-version=2023-11-01

Przykładowa odpowiedź

{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

Definicje

Nazwa Opis
AdminKeyResult

Odpowiedź zawierająca podstawowe i pomocnicze klucze interfejsu API administratora dla danej usługi wyszukiwania.

CloudError

Zawiera informacje o błędzie interfejsu API.

CloudErrorBody

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

AdminKeyResult

Odpowiedź zawierająca podstawowe i pomocnicze klucze interfejsu API administratora dla danej usługi wyszukiwania.

Nazwa Typ Opis
primaryKey

string

Podstawowy klucz interfejsu API administratora usługi wyszukiwania.

secondaryKey

string

Pomocniczy klucz interfejsu API administratora usługi wyszukiwania.

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