Query Keys - Delete

Usługa:
Search Management
Wersja interfejsu API:
2025-02-01-preview

Usuwa określony klucz zapytania. W przeciwieństwie do kluczy administracyjnych klucze zapytań nie są generowane ponownie. Proces ponownego generowania klucza zapytania polega na usunięciu, a następnie ponownym utworzeniu go.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
key
 path True

string

Klucz zapytania do usunięcia. Klucze zapytań są identyfikowane według wartości, a nie według nazwy.
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

Klucz zapytania został pomyślnie usunięty.
204 No Content

Klucz zapytania został pomyślnie usunięty.
404 Not Found

Nie można odnaleźć subskrypcji, grupy zasobów, usługi wyszukiwania lub klucza zapytania.
Other Status Codes

CloudError

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

SearchDeleteQueryKey

Przykładowe żądanie

DELETE https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/deleteQueryKey/<a query API key>?api-version=2025-02-01-preview

Przykładowa odpowiedź

Kod stanu:
200
Kod stanu:
204
Kod stanu:
404

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.

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