Поделиться через

Справочник по REST API управления (поиск Azure AI)

Управляющие REST API службы "Поиск Azure AI " (прежнее название — Azure Cognitive Search) предоставляют программный доступ к административным операциям:

  • Создание, обновление и удаление службы поиска
  • Получение информации о службе поиска
  • Создание, повторное создание или извлечение api-keys (запросы или ключи администратора)
  • Добавление или удаление реплик и секций (настройка емкости)
  • Настройка службы поиска для использования частной конечной точки
  • Включение или отключение управления доступом на основе ролей Azure

Для задач плоскости данных, таких как создание индекса и запрос к нему, используйте REST API службы поиска .

Работа с управляющими REST API

Чтобы полностью программно администрировать службу, необходимо работать с двумя API: REST API управления Azure AI Search, описанным здесь, и общим REST API Azure Resource Manager.

API Resource Manager используется для операций общего назначения, которые не зависят от службы, таких как запрос данных подписки, перечисление географических расположений и т. д. Все вызовы API Resource Manager проходят проверку подлинности с помощью идентификатора Microsoft Entra. Для выполнения вызовов API Resource Manager необходимо иметь членство и назначение ролей в клиенте Microsoft Entra.

Документация по API с версиями

Документация по REST API имеет управление версиями. При открытии справочной страницы API выберите версию API из раскрывающегося фильтра.

снимок экрана селектора версий.

Разрешения и управление доступом

Права администрирования передаются с помощью встроенных ролей в Microsoft Entra ID:

  • Для большинства задач требуются назначения владельца или участника .
  • Роль читателя имеет ограниченный доступ к служебной информации (операции GET, за исключением ключей API, для которых требуются разрешения владельца или контрибьютора).

Дополнительные сведения см. в статье Управление доступом на основе ролей в Поиске Azure AI.

Рекомендуется назначать роли группам, а не отдельным пользователям. Этими назначениями управляет владелец подписки Azure или глобальный администратор. Дополнительные сведения см. в статье Назначение ролей Microsoft Entra группам.

Подключение к конечной точке управления

При настройке подключения начните с конечной точки https://management.azure.com Resource Manager, а затем добавьте идентификатор подписки, поставщика (Microsoft.Search) и версию API. Операции указываются в теле запроса.

Полностью указанная конечная точка состоит из следующих компонентов:

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

Для вызова интерфейсов REST API управления обычно используются следующие клиенты:

Клиент Инструкции и примеры
Azure PowerShell с помощью модуля Az.Search Управление поиском Azure AI с помощью Azure PowerShell
Интерфейс Command-Line Azure (CLI) Управление поиском Azure AI с помощью Azure CLI
Visual Studio Code с клиентом REST Управление поиском Azure AI с помощью REST

Вы также можете управлять службой поиска с помощью портала Azure.

API управления в других пакетах SDK

Интерфейсы REST API являются основой службы поиска Azure AI, и любые изменения в модели программирования в первую очередь отражаются в интерфейсах REST API.

В качестве альтернативы можно использовать следующие пакеты SDK Azure, которые независимо обновляются в отдельных расписаниях выпусков:

См. также

  • Last updated on