Compartilhar via


Listar indexadores (API REST do Azure AI Search)

A operação Listar Indexadores retorna a lista de indexadores no serviço Pesquisa de IA do Azure.

GET https://[service name].search.windows.net/indexers?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]  

Parâmetros de URI

Parâmetro Descrição
nome do serviço Obrigatórios. Defina isso como o nome exclusivo definido pelo usuário do serviço de pesquisa.
api-version Obrigatórios. A versão estável atual é api-version=2020-06-30. Confira Versões de API para obter mais versões.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos de solicitação necessários e opcionais

Campos Descrição
Tipo de conteúdo Obrigatórios. Defina-o como application/json
chave de API Opcional se você estiver usando funções do Azure e um token de portador for fornecido na solicitação, caso contrário, uma chave será necessária. Uma chave de api é uma cadeia de caracteres exclusiva gerada pelo sistema que autentica a solicitação para o serviço de pesquisa. Obter solicitações para uma definição de objeto deve incluir um campo de chave de api definido como sua chave de administrador (em vez de uma chave de consulta). Confira Conectar-se ao Azure AI Search usando a autenticação de chave para obter detalhes.

Corpo da solicitação

Nenhum.

Resposta

Para uma solicitação bem-sucedida: 200 OK. Aqui está um exemplo de corpo de resposta:

{  
      "value" : [  
      {  
        "name" : "myindexer",  
        "description" : "a cool indexer",  
        "dataSourceName" : "ordersds",  
        "targetIndexName" : "orders",  
        ... other indexer properties  
      }]  
    }  

Você pode filtrar a resposta para apenas as propriedades em que você está interessado. Por exemplo, se você quiser apenas uma lista de nomes de indexador, use a opção de consulta OData $select :

GET /indexers?api-version=2020-06-30&$select=name  

Nesse caso, a resposta do exemplo anterior seria exibida da seguinte maneira:

{  
      "value" : [ { "name": "myindexer" } ]  
    }  

Essa é uma técnica útil para economizar largura de banda se você tiver muitos indexadores em seu serviço Search.

Observação

Se um indexador tiver uma chave de criptografia, o serviço de pesquisa deverá ter acesso à chave de criptografia para recuperar propriedades criptografadas na definição desse indexador. Sem acesso à chave de criptografia, um "<encrypted>" espaço reservado é retornado no lugar das propriedades criptografadas. Restaurar o acesso à chave permite que o serviço de pesquisa recupere a definição completa do indexador novamente.

Confira também