Query Keys - Delete

Serviço:

Search Management

Versão da API:

2023-11-01

Exclui a chave de consulta especificada. Ao contrário das chaves de administrador, as chaves de consulta não são regeneradas. O processo para regenerar uma chave de consulta consiste em excluí-la e recriá-la.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
key	path	True	string	A chave de consulta a ser excluída. As chaves de consulta são identificadas por valor, não por nome.
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
searchServiceName	path	True	string	O nome do serviço de pesquisa associado ao grupo de recursos especificado.
subscriptionId	path	True	string	O identificador exclusivo para uma assinatura do Microsoft Azure. Você pode obter esse valor da API de Resource Manager do Azure, das ferramentas de linha de comando ou do portal.
api-version	query	True	string	A versão da API a ser usada para cada solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string uuid	Um valor de GUID gerado pelo cliente que identifica esta solicitação. Se especificado, isso será incluído nas informações de resposta como uma maneira de acompanhar a solicitação.

Respostas

Nome	Tipo	Description
200 OK		A chave de consulta foi excluída com êxito.
204 No Content		A chave de consulta foi excluída com êxito.
404 Not Found		Não foi possível encontrar a assinatura, o grupo de recursos, o serviço de pesquisa ou a chave de consulta.
Other Status Codes	CloudError	HTTP 409 (Conflito): a assinatura especificada está desabilitada.

Segurança

azure_auth

Microsoft Entra ID fluxo de autorização OAuth2.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

SearchDeleteQueryKey

Solicitação de exemplo

HTTP

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

Java

/** Samples for QueryKeys Delete. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchDeleteQueryKey.json
     */
    /**
     * Sample code: SearchDeleteQueryKey.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchDeleteQueryKey(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getQueryKeys().deleteWithResponse("rg1", "mysearchservice",
            "<a query API key>", null, com.azure.core.util.Context.NONE);
    }
}

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

Python

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/stable/2023-11-01/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

Go

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/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/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

JavaScript

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/stable/2023-11-01/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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/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

Resposta de exemplo

Código de status:

200

Código de status:

204

Código de status:

404

Definições

Nome	Description
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.

CloudError

Contém informações sobre um erro de API.

Nome	Tipo	Description
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.

CloudErrorBody

Descreve um erro de API específico com um código de erro e uma mensagem.

Nome	Tipo	Description
code	string	Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados a esse erro.
message	string	Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).