Referência da API REST de Gestão (Pesquisa de IA do Azure)

  • Artigo

As APIs REST de Gestão do Pesquisa de IA do Azure (anteriormente conhecidas como Azure Cognitive Search) fornecem acesso programático às operações administrativas:

  • Criar, atualizar e eliminar um serviço de pesquisa
  • Obter informações do serviço de pesquisa
  • Criar, regenerar ou obter api-keys (chaves de consulta ou de administrador)
  • Adicionar ou remover réplicas e partições (ajustar a capacidade)
  • Configurar um serviço de pesquisa para utilizar um ponto final privado
  • Ativar ou desativar o controlo de acesso baseado em funções do Azure

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

Como trabalhar com as APIs REST de gestão

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

A API de Resource Manager é utilizada para operações para fins gerais que não são específicas do serviço, como consultar dados de subscrição, listar localizações geográficas, etc. Todas as chamadas à API Resource Manager são autenticadas com Microsoft Entra ID. Tem de ter associação e uma atribuição de função num inquilino Microsoft Entra para efetuar chamadas à API Resource Manager.

Documentos da API com versão

Os documentos da API REST estão agora em versão. Quando abrir uma página de referência da API, selecione a versão da API no filtro pendente.

Captura de ecrã do seletor de versões.

Permissões e controlo de acesso

Os direitos de administração são transmitidos através de funções incorporadas no Microsoft Entra ID:

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

Para obter mais informações, veja Controlo de acesso baseado em funções no Azure AI Pesquisa.

Uma melhor prática é atribuir funções a grupos em vez de utilizadores individuais. Um proprietário de subscrição do Azure ou administrador global gere estas atribuições. Para obter mais informações, veja Atribuir funções de Microsoft Entra a grupos.

Ligar ao ponto final de gestão

Ao configurar a ligação, comece com o ponto https://management.azure.com final Resource Manager e, em seguida, adicione o ID da subscrição, o fornecedor (Microsoft.Search) e a versão da API. As operações são especificadas no corpo do pedido.

Um ponto final 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 normalmente utilizados para chamar as APIs REST de gestão:

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

Também pode gerir um serviço de pesquisa com o portal do Azure.

APIs de gestão noutros SDKs

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

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

Ver também