Referência da API REST de gerenciamento (Pesquisa de IA do Azure )

As APIs REST de gerenciamento do Pesquisa de IA do Azure  (anteriormente conhecidas como Azure Cognitive Search) fornecem acesso programático a operações administrativas:

  • Criar, atualizar e excluir um serviço de pesquisa
  • Recuperar informações do serviço de pesquisa
  • Criar, regenerar ou recuperar api-keys (chaves de consulta ou de administração)
  • Adicionar ou remover réplicas e partições (ajustar a capacidade)
  • Configurar um serviço de pesquisa para usar um ponto de extremidade privado
  • Habilitar ou desabilitar o controle de acesso baseado em função do Azure

Para tarefas do plano de dados, como criar e consultar um índice, use as APIs REST do Serviço de Pesquisa .

Como trabalhar com as APIs REST de gerenciamento

Para administrar totalmente seu serviço programaticamente, você trabalha com duas APIs: a API REST de Gerenciamento do Pesquisa de IA do Azure  documentada aqui, além da API REST comum do Azure Resource Manager.

A API do Resource Manager é usada para operações de uso geral que não são específicas do serviço, como consultar dados de assinatura, listar localizações geográficas e assim por diante. Todas as chamadas à API do Resource Manager são autenticadas usando a ID do Microsoft Entra. Você deve ter associação e uma atribuição de função em um locatário do Microsoft Entra para fazer chamadas à API do Resource Manager.

Documentos de API com versão

Os documentos da API REST são versionados. Quando você abre uma página de referência de API, um seletor de versão aparece acima do sumário. O seletor fica disponível quando você escolhe uma página da pasta Reference > Resource Manager.

Captura de tela do seletor de versão.

Permissões e controle de acesso

Os direitos de administração são transmitidos por meio de funções internas na ID do Microsoft Entra:

  • As atribuições de Proprietário ou Colaborador são necessárias para a maioria das tarefas.
  • A função de leitor tem acesso limitado às informações de serviço (operações GET, exceto para chaves de API, que exigem permissões de Proprietário ou Colaborador).

Para obter mais informações, consulte Controle de acesso baseado em função no Pesquisa de IA do Azure .

Uma prática recomendada é atribuir funções a grupos em vez de usuários individuais. Um proprietário de assinatura do Azure ou administrador global gerencia essas atribuições. Para obter mais informações, consulte Atribuir funções do Microsoft Entra a grupos.

Conectar-se ao ponto de extremidade de gerenciamento

Ao configurar a conexão, comece com o ponto de extremidade https://management.azure.com do Resource Manager e adicione a ID da assinatura, o provedor (Microsoft.Search) e a versão da API. As operações são especificadas no corpo da solicitação.

Um ponto de extremidade totalmente especificado tem os seguintes componentes:

https://management.azure.com/subscriptions/[subscriptionId]/resourceGroups/[resourceGroupName]/providers/Microsoft.Search/searchServices/[serviceName]?api-version=2020-08-01

Os seguintes clientes são comumente usados para chamar as APIs REST de gerenciamento:

Cliente Instruções e exemplos
Azure PowerShell usando o módulo Az.Search Gerenciar o Pesquisa de IA do Azure  usando o Azure PowerShell
CLI (Interface de Linha de Comando) do Azure Gerenciar o Pesquisa de IA do Azure  usando a CLI do Azure
Visual Studio Code com um cliente REST Gerenciar o Pesquisa de IA do Azure  usando REST

Você também pode gerenciar um serviço de pesquisa usando o portal do Azure.

APIs de gerenciamento em outros SDKs

As APIs REST são fundamentais para o Pesquisa de IA do Azure  e todas as alterações no modelo de programação são refletidas primeiro nas APIs REST.

As alternativas incluem os seguintes SDKs do Azure, que são atualizados independentemente em agendas de lançamento separadas:

Consulte também

  • Last updated on