Query Keys - Delete

Service:: Search Management

API-versie:: 2026-11-01

Hiermee verwijdert u de opgegeven querysleutel. In tegenstelling tot beheerderssleutels worden querysleutels niet opnieuw gegenereerd. Het proces voor het opnieuw genereren van een querysleutel is het verwijderen en vervolgens opnieuw maken. Geeft 200 (OK) terug bij succesvolle verwijdering, 204 (Geen Content) als de dienst bestaat maar de querysleutels niet gevonden, of 404 (Niet gevonden) als de dienst niet wordt gevonden. OPMERKING: Het gedrag van het teruggeven van 404 is niet in overeenstemming met de ARM-richtlijnen. Clients kunnen in toekomstige versies een 204-antwoord verwachten en nieuwe afhankelijkheden van de 404-respons vermijden.

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

URI-parameters

Naam	In	Vereist	Type	Description
key	path	True	string	De querysleutel die moet worden verwijderd. Querysleutels worden geïdentificeerd op basis van een waarde, niet op basis van de naam.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resource group. De naam is hoofdletterongevoelig.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	De naam van de Azure AI Zoeken-service die is gekoppeld aan de opgegeven resourcegroep.
subscriptionId	path	True	string (uuid)	De ID van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Naam	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	Een door de client gegenereerde GUID-waarde die deze aanvraag identificeert. Indien opgegeven, wordt dit opgenomen in antwoordinformatie als een manier om de aanvraag bij te houden.

Antwoorden

Naam	Type	Description
200 OK		De aanvraag is voltooid.
204 No Content		Er is geen inhoud die voor deze aanvraag kan worden verzonden, maar de headers kunnen nuttig zijn.
404 Not Found		De aangevraagde resource kan niet worden gevonden op de server.
Other Status Codes	CloudError	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Naam	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

SearchDeleteQueryKey

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

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.
 * Returns 200 (OK) on successful deletion, 204 (No Content) if the service exists but the query keys not found, or 404 (Not Found) if the service is not found.
 * NOTE: The behavior of returning 404 is inconsistent with ARM guidelines. Clients should expect a 204 response in future versions and avoid new dependencies on the 404 response.
 *
 * @summary deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.
 * Returns 200 (OK) on successful deletion, 204 (No Content) if the service exists but the query keys not found, or 404 (Not Found) if the service is not found.
 * NOTE: The behavior of returning 404 is inconsistent with ARM guidelines. Clients should expect a 204 response in future versions and avoid new dependencies on the 404 response.
 * x-ms-original-file: 2026-11-01/SearchDeleteQueryKey.json
 */
async function searchDeleteQueryKey() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new SearchManagementClient(credential, subscriptionId);
  await client.queryKeys.delete("rg1", "mysearchservice", "<a query API key>");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Voorbeeldrespons

Statuscode:: 200

Statuscode:: 204

Statuscode:: 404

Definities

Naam	Description
CloudError	Bevat informatie over een API-fout.
CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.

CloudError

Object

Bevat informatie over een API-fout.

Naam	Type	Description
error	CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
message	string	Een korte beschrijving van de fout die aangeeft wat er fout is gegaan (voor informatie over details/foutopsporing raadpleegt u de eigenschap 'error.message').

CloudErrorBody

Object

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

Naam	Type	Description
code	string	Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt om programmatisch specifieke foutcases af te handelen.
details	CloudErrorBody[]	Bevat geneste fouten die betrekking hebben op deze fout.
message	string	Een bericht met een gedetailleerde beschrijving van de fout en informatie over foutopsporing.
target	string	Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).