Elimina la clave de consulta especificada. A diferencia de las claves de administración, las claves de consulta no se vuelven a generar. El proceso para volver a generar la clave de consulta consiste en eliminarla y volver a crearla.
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}?api-version=2024-03-01-preview
Parámetros de identificador URI
| Nombre |
En |
Requerido |
Tipo |
Description |
|
key
|
path |
True
|
string
|
Clave de consulta que se va a eliminar. Las claves de consulta se identifican por valor, no por nombre.
|
|
resourceGroupName
|
path |
True
|
string
|
Nombre del grupo de recursos dentro de la suscripción actual. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
|
|
searchServiceName
|
path |
True
|
string
|
Nombre del servicio Search de Azure AI asociado al grupo de recursos especificado.
Patrón de Regex: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
|
|
subscriptionId
|
path |
True
|
string
|
Identificador único de una suscripción de Microsoft Azure. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
|
|
api-version
|
query |
True
|
string
|
La versión de API que se va a usar para cada solicitud.
|
| Nombre |
Requerido |
Tipo |
Description |
|
x-ms-client-request-id
|
|
string
uuid
|
Un valor GUID generado por el cliente que identifica esta solicitud. Si se especifica, se incluirá en la información de respuesta como una manera de realizar un seguimiento de la solicitud.
|
Respuestas
| Nombre |
Tipo |
Description |
|
200 OK
|
|
La clave de consulta se eliminó correctamente.
|
|
204 No Content
|
|
La clave de consulta se eliminó correctamente.
|
|
404 Not Found
|
|
No se encontró la suscripción, el grupo de recursos, el servicio de búsqueda o la clave de consulta.
|
|
Other Status Codes
|
CloudError
|
HTTP 409 (conflicto): la suscripción especificada está deshabilitada.
|
Seguridad
azure_auth
Especifica un flujo de concesión implícita, como se admite en la plataforma de identidad de Microsoft.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre |
Description |
|
user_impersonation
|
suplantación de su cuenta de usuario
|
Ejemplos
SearchDeleteQueryKey
Solicitud de ejemplo
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
Definiciones
| Nombre |
Description |
|
CloudError
|
Contiene información sobre un error de API.
|
|
CloudErrorBody
|
Describe un error de API determinado con un código de error y un mensaje.
|
CloudError
Contiene información sobre un error de API.
| Nombre |
Tipo |
Description |
|
error
|
CloudErrorBody
|
Describe un error de API determinado con un código de error y un mensaje.
|
|
message
|
string
|
Una breve descripción del error que indica lo que salió mal (para obtener detalles o información de depuración, consulte la propiedad "error.message").
|
CloudErrorBody
Describe un error de API determinado con un código de error y un mensaje.
| Nombre |
Tipo |
Description |
|
code
|
string
|
Código de error que describe la condición de error de forma más precisa que un código de estado HTTP. Se puede usar para controlar mediante programación casos de error específicos.
|
|
details
|
CloudErrorBody[]
|
Contiene errores anidados relacionados con este error.
|
|
message
|
string
|
Mensaje que describe el error en detalle y proporciona información de depuración.
|
|
target
|
string
|
Destino del error determinado (por ejemplo, el nombre de la propiedad en error).
|