Query Keys - List By Search Service

Serviço:: Search Management

Versão da API:: 2023-11-01

Retorna 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 de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura atual. Você pode obter esse valor na API do Azure Resource Manager ou no 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 assinatura do Microsoft Azure. Você pode obter esse valor da API do Azure Resource Manager, das ferramentas de linha de comando ou do portal.
api-version	query	True	string	A versão da API a ser usada para cada solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
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 maneira de acompanhar a solicitação.

Respostas

Nome	Tipo	Description
200 OK	ListQueryKeysResult	Todas as chaves de consulta para o serviço de pesquisa especificado foram recuperadas com êxito e estão na resposta. Você pode usar qualquer uma das chaves de consulta como o valor do parâmetro 'api-key' na API REST do plano de dados ou um SDK do Azure para executar operações somente leitura na coleção de documentos de 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

Fluxo de autorização do Microsoft Entra ID OAuth2.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

SearchListQueryKeysBySearchService

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Nome	Description
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.
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

Objeto

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

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

CloudErrorBody

Objeto

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

Nome	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 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).

ListQueryKeysResult

Objeto

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

Nome	Tipo	Description
nextLink	string	Url de solicitação que pode ser usada para consultar a próxima página de chaves de consulta. Retornado quando o número total de chaves de consulta solicitadas excede o tamanho máximo da página.
value	QueryKey[]	As chaves de consulta do serviço de pesquisa.

QueryKey

Objeto

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

Nome	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.