Query Keys - Create

Serviço:

Search Management

Versão da API:

2023-11-01

Gera uma nova chave de consulta para o serviço de pesquisa especificado. Pode criar até 50 chaves de consulta por serviço.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
name	path	True	string	O nome da nova chave de API de consulta.
resourceGroupName	path	True	string	O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou 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 de uma subscrição do Microsoft Azure. Pode obter este valor a partir da API de Resource Manager do Azure, das ferramentas de linha de comandos ou do portal.
api-version	query	True	string	A versão da API a utilizar para cada pedido.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	Um valor GUID gerado pelo cliente que identifica este pedido. Se for especificado, isto será incluído nas informações de resposta como forma de controlar o pedido.

Respostas

Name	Tipo	Description
200 OK	QueryKey	A chave de consulta foi criada com êxito e está na resposta. Pode utilizar a chave de consulta como o valor do parâmetro "api-key" na API REST do plano de dados ou num SDK do Azure para realizar operações só de leitura nos índices de Pesquisa, como consultar e procurar documentos por ID.
Other Status Codes	CloudError	HTTP 404 (Não Encontrado): não foi possível localizar a subscrição, o grupo de recursos ou o serviço de pesquisa. HTTP 409 (Conflito): a subscrição especificada está desativada.

Segurança

azure_auth

Microsoft Entra ID fluxo de autorização OAuth2.

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

SearchCreateQueryKey

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/Query key for browser-based clients?api-version=2023-11-01

Java

/**
 * Samples for QueryKeys Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchCreateQueryKey.json
     */
    /**
     * Sample code: SearchCreateQueryKey.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchCreateQueryKey(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getQueryKeys().createWithResponse("rg1", "mysearchservice",
            "Query key for browser-based clients", 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_create_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",
    )

    response = client.query_keys.create(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
        name="Query key for browser-based clients",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchCreateQueryKey.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/SearchCreateQueryKey.json
func ExampleQueryKeysClient_Create() {
	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)
	}
	res, err := clientFactory.NewQueryKeysClient().Create(ctx, "rg1", "mysearchservice", "Query key for browser-based clients", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.QueryKey = armsearch.QueryKey{
	// 	Name: to.Ptr("Query key for browser-based clients"),
	// 	Key: to.Ptr("<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

JavaScript

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

/**
 * This sample demonstrates how to Generates a new query key for the specified search service. You can create up to 50 query keys per service.
 *
 * @summary Generates a new query key for the specified search service. You can create up to 50 query keys per service.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchCreateQueryKey.json
 */
async function searchCreateQueryKey() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const name = "Query key for browser-based clients";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.queryKeys.create(resourceGroupName, searchServiceName, name);
  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/SearchCreateQueryKey.json
// this example is just showing the usage of "QueryKeys_Create" 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 name = "Query key for browser-based clients";
SearchServiceQueryKey result = await searchService.CreateQueryKeyAsync(name);

Console.WriteLine($"Succeeded: {result}");

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

Resposta da amostra

Código de estado:

200

{
  "name": "Query key for browser-based clients",
  "key": "<a query API key>"
}

Definições

Name	Description
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro específico da API com um código de erro e uma mensagem.
QueryKey	Descreve uma chave de API para um determinado serviço de pesquisa que tem permissões apenas para operações de consulta.

CloudError

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

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

CloudErrorBody

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

Name	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 estado HTTP. Pode ser utilizado para processar programaticamente casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados com este erro.
message	string	Uma mensagem que descreve o erro em detalhe e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

QueryKey

Descreve uma chave de API para um determinado serviço de pesquisa que tem permissões apenas para operações de consulta.

Name	Tipo	Description
key	string	O valor da chave da API de consulta.
name	string	O nome da chave da API de consulta; pode estar vazio.