Query Keys - Delete

Dienst:
Search Management
API-Version:
2023-11-01

Löscht den angegebenen Abfrageschlüssel. Im Gegensatz zu Administratorschlüsseln werden Abfrageschlüssel nicht neu generiert. Der Prozess zum Generieren eines Abfrageschlüssels besteht darin, ihn zu löschen und dann neu zu erstellen.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
key
 path True

string

Der zu löschende Abfrageschlüssel. Abfrageschlüssel werden anhand des Werts und nicht anhand des Namens identifiziert.
resourceGroupName
 path True

string

Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
searchServiceName
 path True

string

Der Name des Suchdiensts, der der angegebenen Ressourcengruppe zugeordnet ist.
subscriptionId
 path True

string

Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Sie können diesen Wert aus der Azure Resource Manager-API, den Befehlszeilentools oder dem Portal abrufen.
api-version
 query True

string

Die API-Version, die für jede Anforderung verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-request-id

string (uuid)

Ein vom Client generierter GUID-Wert, der diese Anforderung identifiziert. Wenn angegeben, wird dies in Antwortinformationen eingeschlossen, um die Anforderung nachzuverfolgen.

Antworten

Name Typ Beschreibung
200 OK

Der Abfrageschlüssel wurde erfolgreich gelöscht.
204 No Content

Der Abfrageschlüssel wurde erfolgreich gelöscht.
404 Not Found

Das Abonnement, die Ressourcengruppe, der Suchdienst oder der Abfrageschlüssel konnten nicht gefunden werden.
Other Status Codes

CloudError

HTTP 409 (Konflikt): Das angegebene Abonnement ist deaktiviert.

Sicherheit

azure_auth

Microsoft Entra ID OAuth2-Autorisierungsfluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

SearchDeleteQueryKey

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200
Statuscode:
204
Statuscode:
404

Definitionen

Name Beschreibung
CloudError

Enthält Informationen zu einem API-Fehler.
CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

CloudError

Objekt

Enthält Informationen zu einem API-Fehler.

Name Typ Beschreibung
error

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

CloudErrorBody

Objekt

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

Name Typ Beschreibung
code

string

Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-Statuscode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details

CloudErrorBody[]

Enthält geschachtelte Fehler, die mit diesem Fehler zusammenhängen.
message

string

Eine Meldung, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt.
target

string

Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).