Hiermee verwijdert u de opgegeven querysleutel. In tegenstelling tot beheerderssleutels worden querysleutels niet opnieuw gegenereerd. Het proces voor het opnieuw genereren van een querysleutel bestaat uit het verwijderen en opnieuw maken van de sleutel.
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}?api-version=2024-03-01-preview
URI-parameters
| Name |
In |
Vereist |
Type |
Description |
|
key
|
path |
True
|
string
|
De querysleutel die moet worden verwijderd. Querysleutels worden geïdentificeerd op waarde, niet op naam.
|
|
resourceGroupName
|
path |
True
|
string
|
De naam van de resourcegroep binnen het huidige abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
|
|
searchServiceName
|
path |
True
|
string
|
De naam van de Azure AI-Search-service gekoppeld aan de opgegeven resourcegroep.
Regex-patroon: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
|
|
subscriptionId
|
path |
True
|
string
|
De unieke id voor een Microsoft Azure-abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
|
|
api-version
|
query |
True
|
string
|
De API-versie die voor elke aanvraag moet worden gebruikt.
|
| Name |
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 de antwoordinformatie als een manier om de aanvraag bij te houden.
|
Antwoorden
| Name |
Type |
Description |
|
200 OK
|
|
De querysleutel is verwijderd.
|
|
204 No Content
|
|
De querysleutel is verwijderd.
|
|
404 Not Found
|
|
Kan het abonnement, de resourcegroep, de zoekservice of de querysleutel niet vinden.
|
|
Other Status Codes
|
CloudError
|
HTTP 409 (conflict): het opgegeven abonnement is uitgeschakeld.
|
Beveiliging
azure_auth
Hiermee geeft u een impliciete toekenningsstroom op, zoals ondersteund op het Microsoft Identity-platform.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
| Name |
Description |
|
user_impersonation
|
uw gebruikersaccount imiteren
|
Voorbeelden
SearchDeleteQueryKey
Voorbeeldaanvraag
DELETE https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/deleteQueryKey/<a query API key>?api-version=2024-03-01-preview
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-search
# USAGE
python search_delete_query_key.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = SearchManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
client.query_keys.delete(
resource_group_name="rg1",
search_service_name="mysearchservice",
key="<a query API key>",
)
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchDeleteQueryKey.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armsearch_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchDeleteQueryKey.json
func ExampleQueryKeysClient_Delete() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewQueryKeysClient().Delete(ctx, "rg1", "mysearchservice", "<a query API key>", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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.
*
* @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.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchDeleteQueryKey.json
*/
async function searchDeleteQueryKey() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const key = "<a query API key>";
const credential = new DefaultAzureCredential();
const client = new SearchManagementClient(credential, subscriptionId);
const result = await client.queryKeys.delete(resourceGroupName, searchServiceName, key);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchDeleteQueryKey.json
// this example is just showing the usage of "QueryKeys_Delete" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
string key = "<a query API key>";
await searchService.DeleteQueryKeyAsync(key);
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Definities
| Name |
Description |
|
CloudError
|
Bevat informatie over een API-fout.
|
|
CloudErrorBody
|
Beschrijft een bepaalde API-fout met een foutcode en een bericht.
|
CloudError
Bevat informatie over een API-fout.
| Name |
Type |
Description |
|
error
|
CloudErrorBody
|
Beschrijft een bepaalde API-fout met een foutcode en een bericht.
|
|
message
|
string
|
Een korte beschrijving van de fout die aandukt wat er mis is gegaan (raadpleeg de eigenschap 'error.message' voor meer informatie over foutopsporing).
|
CloudErrorBody
Beschrijft een bepaalde API-fout met een foutcode en een bericht.
| Name |
Type |
Description |
|
code
|
string
|
Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt voor het programmatisch afhandelen van specifieke foutgevallen.
|
|
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).
|