Query Keys - List By Search Service

Service:

Search Management

API Version:

2023-11-01

Devolve a lista de chaves de API de consulta para o serviço de pesquisa especificado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
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	ListQueryKeysResult	Todas as chaves de consulta do serviço de pesquisa especificado foram obtidas com êxito e estão na resposta. Pode utilizar qualquer uma das chaves 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 na coleção de documentos dos í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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

SearchListQueryKeysBySearchService

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listQueryKeys?api-version=2023-11-01

Java

/** Samples for QueryKeys ListBySearchService. */
public final class Main {
    /*
     * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
     * SearchListQueryKeysBySearchService.json
     */
    /**
     * Sample code: SearchListQueryKeysBySearchService.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchListQueryKeysBySearchService(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getQueryKeys().listBySearchService("rg1", "mysearchservice",
            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_list_query_keys_by_search_service.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.list_by_search_service(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListQueryKeysBySearchService.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/SearchListQueryKeysBySearchService.json
func ExampleQueryKeysClient_NewListBySearchServicePager() {
	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)
	}
	pager := clientFactory.NewQueryKeysClient().NewListBySearchServicePager("rg1", "mysearchservice", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ListQueryKeysResult = armsearch.ListQueryKeysResult{
		// 	Value: []*armsearch.QueryKey{
		// 		{
		// 			Name: to.Ptr("Query key for browser-based clients"),
		// 			Key: to.Ptr("<a query API key>"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Query key for mobile clients"),
		// 			Key: to.Ptr("<another 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 Returns the list of query API keys for the given Azure Cognitive Search service.
 *
 * @summary Returns the list of query API keys for the given Azure Cognitive Search service.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListQueryKeysBySearchService.json
 */
async function searchListQueryKeysBySearchService() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.queryKeys.listBySearchService(
    resourceGroupName,
    searchServiceName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/SearchListQueryKeysBySearchService.json
// this example is just showing the usage of "QueryKeys_ListBySearchService" 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 and iterate over the result
await foreach (SearchServiceQueryKey item in searchService.GetQueryKeysBySearchServiceAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

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

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "Query key for browser-based clients",
      "key": "<a query API key>"
    },
    {
      "name": "Query key for mobile clients",
      "key": "<another 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.
ListQueryKeysResult	Resposta que contém as chaves da API de consulta para um determinado serviço de pesquisa.
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).

ListQueryKeysResult

Resposta que contém as chaves da API de consulta para um determinado serviço de pesquisa.

Name	Tipo	Description
nextLink	string	URL do pedido que pode ser utilizado para consultar a página seguinte das chaves de consulta. Devolvido quando o número total de chaves de consulta pedidas exceder o tamanho máximo da página.
value	QueryKey[]	As chaves de consulta do serviço de pesquisa.

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.