Query Keys - Create

Serviço:: Search Management

Versão da API:: 2025-02-01-preview

Gera uma nova chave de consulta para o serviço de pesquisa especificado. Você 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=2025-02-01-preview

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
name	path	True	string	O nome da nova chave de API de consulta.
resourceGroupName	path	True	string	O nome do grupo de recursos dentro da assinatura atual. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	O nome do serviço Azure AI Search associado ao grupo de recursos especificado.
subscriptionId	path	True	string	O identificador exclusivo de uma assinatura do Microsoft Azure. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
api-version	query	True	string	A versão da API a ser usada para cada solicitação.

Cabeçalho do Pedido

Name	Obrigatório	Tipo	Descrição
x-ms-client-request-id		string (uuid)	Um valor GUID gerado pelo cliente que identifica essa solicitação. Se especificado, isso será incluído nas informações de resposta como uma forma de rastrear a solicitação.

Respostas

Name	Tipo	Descrição
200 OK	QueryKey	A chave de consulta foi criada com êxito e está na resposta. Você pode usar a chave de consulta como o valor do parâmetro 'api-key' na API REST ou SDK do serviço Azure AI Search para executar operações somente leitura em seus índices de pesquisa, como consultar e pesquisar documentos por ID.
Other Status Codes	CloudError	HTTP 404 (Não encontrado): Não foi possível encontrar a assinatura, o grupo de recursos ou o serviço de pesquisa. HTTP 409 (Conflito): A assinatura especificada está desabilitada.

Segurança

azure_auth

Especifica um fluxo de concessão implícito, conforme suportado na plataforma Microsoft Identity.

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

Âmbitos

Name	Descrição
user_impersonation	personificar 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/An API key granting read-only access to the documents collection of an index.?api-version=2025-02-01-preview

Resposta da amostra

Código de estado:: 200

{
  "name": "An API key granting read-only access to the documents collection of an index.",
  "key": "<a query API key>"
}

Definições

Name	Descrição
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.
QueryKey	Descreve uma chave de API para um determinado serviço Azure AI Search que transmite permissões somente leitura na coleção de documentos de um índice.

CloudError

Object

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

Name	Tipo	Descrição
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
message	string	Uma breve descrição do erro que sugere o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

Object

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

Name	Tipo	Descrição
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).

QueryKey

Object

Descreve uma chave de API para um determinado serviço Azure AI Search que transmite permissões somente leitura na coleção de documentos de um índice.

Name	Tipo	Descrição
key	string	O valor da chave da API de consulta.
name	string	O nome da chave da API de consulta. Os nomes de consulta são opcionais, mas atribuir um nome pode ajudá-lo a lembrar como ele é usado.