Partilhar via


Query Keys - List By Search Service

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.

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

SearchListQueryKeysBySearchService

Pedido de amostra

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

Resposta da amostra

{
  "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.