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

  • Artigo

As APIs REST de Gerenciamento do Azure AI Pesquisa (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 administrador)
  • 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 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 da IA do Azure Pesquisa documentada aqui, além da API REST comum do Azure Resource Manager.

A API 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 locais geográficos e assim por diante. Todas as chamadas à API Resource Manager são autenticadas usando Microsoft Entra ID. Você deve ter associação e uma atribuição de função em um locatário Microsoft Entra para fazer Resource Manager chamadas à API.

Documentos de API com versão

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

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 no Microsoft Entra ID:

  • As atribuições de proprietário ou colaborador são necessárias para a maioria das tarefas.
  • A função leitor tem acesso limitado a 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, confira 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 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.Pesquisa Gerenciar Pesquisa de IA do Azure usando Azure PowerShell
CLI (interface de linha de comando) do Azure Gerenciar Pesquisa de IA do Azure usando a CLI do Azure
Visual Studio Code com o cliente REST Gerenciar 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 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:

Confira também