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

  • Статья

REST API управления Поиск ИИ Azure (прежнее название — Когнитивный поиск Azure) предоставляют программный доступ к административным операциям:

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

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

Как работать с REST API управления

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

API Resource Manager используется для операций общего назначения, не относящихся к службе, таких как запрос данных подписки, перечисление географических расположений и т. д. Все вызовы API Resource Manager проходят проверку подлинности с помощью Microsoft Entra ID. Для выполнения вызовов 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.Поиск Управление Поиск ИИ Azure с помощью Azure PowerShell
Интерфейс командной строки Azure (CLI) Управление Поиск ИИ Azure с помощью Azure CLI
Visual Studio Code с помощью клиента REST Управление Поиск ИИ Azure с помощью REST

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

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

ИНТЕРФЕЙСы REST API являются базовыми для azure AI Поиск, и любые изменения в модели программирования сначала отражаются в REST API.

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

См. также раздел