Admin Keys - Regenerate

Usługa:: Search Management

Wersja interfejsu API:: 2025-02-01-preview

Ponownie generuje podstawowy lub pomocniczy klucz interfejsu API administratora. Jednocześnie można wygenerować tylko jeden klucz.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
keyKind	path	True	AdminKeyKind	Określa klucz do ponownego wygenerowania. Prawidłowe wartości to "primary" i "secondary".
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	AdminKeyResult	Określony klucz administratora został pomyślnie wygenerowany ponownie. Oba klucze administratora są uwzględniane w odpowiedzi, w tym nowo wygenerowany klucz.
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

SearchRegenerateAdminKey

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
AdminKeyKind	Określa klucz do ponownego wygenerowania. Prawidłowe wartości to "primary" i "secondary".
AdminKeyResult	Odpowiedź zawierająca podstawowe i pomocnicze klucze interfejsu API administratora dla danej usługi Azure AI Search.
CloudError	Zawiera informacje o błędzie interfejsu API.
CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

AdminKeyKind

Wyliczenie

Określa klucz do ponownego wygenerowania. Prawidłowe wartości to "primary" i "secondary".

Wartość	Opis
primary	Podstawowy klucz interfejsu API dla usługi wyszukiwania.
secondary	Pomocniczy klucz interfejsu API dla usługi wyszukiwania.

AdminKeyResult

Objekt

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

Nazwa	Typ	Opis
primaryKey	string	Podstawowy klucz interfejsu API administratora usługi wyszukiwania.
secondaryKey	string	Pomocniczy klucz interfejsu API administratora usługi wyszukiwania.

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