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

Справочник по политикам службы управления API

  • Статья

ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни управления API

В этом разделе приведены краткие описания и ссылки на справочные статьи для всех политик Управление API. Указаны шлюзы управления API, поддерживающие каждую политику. Подробные параметры политики и примеры см. в связанных справочных статьях.

Дополнительные сведения о политиках:

Внимание

Ограничение частоты звонков по подписке и установка квоты использования по подписке имеет зависимость от ключа подписки. Ключ подписки не требуется при применении других политик.

Ограничение скорости и квоты

Политика Описание Классическое Версия 2 Потребление Самостоятельный хостинг Рабочая область
Ограничение частоты звонков по подписке Предотвращает пики использования API путем ограничения частоты вызовов на основе каждой подписки. Да Да Да Да Да
Ограничение частоты звонков по ключу Предотвращает пики в использовании API, ограничивая частоту вызовов для каждого ключа. Да Да Нет Да Да
Настройка квоты использования по подписке Позволяет применять возобновляемую или пожизненную квоту для объема вызовов и/или пропускной способности на каждую подписку. Да Да Да Да Да
Настройка квоты использования по ключу Позволяет применять возобновляемый или пожизненный объем вызовов и/или квоту пропускной способности для каждого ключа. Да Нет Нет Да Да
Ограничение параллелизма Предотвращает выполнение вложенных политик более чем указанным количеством запросов одновременно. Да Да Да Да Да
Ограничение использования маркера службы OpenAI в Azure Предотвращает пики использования API OpenAI Azure, ограничивая количество токенов крупных языковых моделей на вычисляемый ключ. Да Да Нет Да Да
Ограничение использования маркера API для крупной языковой модели Предотвращает пики использования API больших языковых моделей (LLM), ограничивая количество токенов LLM на вычисляемый ключ. Да Да Нет Да Да

Проверка подлинности и авторизация

Политика Описание Классическое Версия 2 Потребление Самостоятельный хостинг Рабочая область
Проверка заголовка HTTP Гарантирует существование и/или значение заголовка HTTP. Да Да Да Да Да
Получение контекста авторизации Возвращает контекст авторизации для указанного подключения к поставщику учетных данных, настроенного в экземпляре Управления API. Да Да Да Нет Нет
Ограничение IP-адресов вызывающих Фильтры (разрешают или запрещают) вызовы с определённых IP-адресов и/или диапазонов адресов. Да Да Да Да Да
Проверка токена Microsoft Entra Обеспечивает существование и допустимость Microsoft Entra (ранее называемого Azure Active Directory) JWT, извлеченного из либо указанного заголовка HTTP, либо параметра запроса, либо значения токена. Да Да Да Да Да
Проверка JWT Применяет существование и допустимость JWT, извлеченного из указанного заголовка HTTP, параметра запроса или значения токена. Да Да Да Да Да
Проверка сертификата клиента Обеспечивает, что сертификат, представленный клиентом экземпляру управления API, соответствует указанным правилам валидации и заявлениям. Да Да Да Да Да
Проверка подлинности с помощью "Базовый" Выполняет аутентификацию на сервере с использованием базовой аутентификации. Да Да Да Да Да
Проверка подлинности с помощью сертификата клиента Выполняет проверку подлинности с помощью серверной службы с помощью сертификатов клиента. Да Да Да Да Да
Проверка подлинности с помощью управляемого удостоверения Выполняет проверку подлинности с помощью серверной службы с помощью управляемого удостоверения. Да Да Да Да Нет

Проверка содержимого

Политика Описание Классическое Версия 2 Потребление Самостоятельный хостинг Рабочая область
Принудительное применение проверок безопасности содержимого для запросов LLM Обеспечивает проверку безопасности содержимого запросов LLM, передавая их в службу безопасности содержимого Azure AI прежде чем отправить в серверную часть LLM. Да Да Да Да Да
Проверка содержимого Проверяет размер или содержимое текста запроса или ответа на одну или несколько схем API. Поддерживаемые форматы схемы — JSON и XML. Да Да Да Да Да
Проверка запроса GraphQL Проверяет и авторизует запрос к API GraphQL. Да Да Да Да Нет
Проверка запроса OData Проверяет запрос к API OData, чтобы обеспечить соответствие спецификации OData. Да Да Да Да Да
Проверка параметров Проверяет заголовок запроса, параметры в запросе или пути на соответствие схеме API. Да Да Да Да Да
Проверка заголовков Проверяет заголовки ответа на схему API. Да Да Да Да Да
Проверка кода состояния Проверяет коды состояния HTTP в ответах на схему API. Да Да Да Да Да

Маршрутизация

Политика Описание Классическое Версия 2 Потребление Самостоятельный хостинг Рабочая область
Перенаправляющий запрос Перенаправляет запрос в серверную службу. Да Да Да Да Да
Настройка серверной службы Изменяет базовый URL-адрес внутренней службы входящего запроса на URL-адрес или бекенд. Ссылка на внутренний ресурс позволяет управлять базовым URL-адресом серверной службы и другими параметрами в одном месте. Кроме того, реализуйте балансировку нагрузки трафика в пуле внутренних служб и правил разбиения каналов для защиты серверной части от слишком большого количества запросов. Да Да Да Да Да
Настройка прокси-сервера HTTP Позволяет направлять перенаправленные запросы через прокси-сервер HTTP. Да Да Да Да Да

Кэширование

Политика Описание Классическое Версия 2 Потребление Самостоятельный хостинг Рабочая область
Получение из кэша Выполняет поиск кэша и возвращает допустимый кэшированный ответ при наличии. Да Да Да Да Да
Хранение в кэше Кэширует ответ в соответствии с указанной конфигурацией элемента управления кэшем. Да Да Да Да Да
Получение значения из кэша Извлекает кэшированный элемент по ключу. Да Да Да Да Да
Сохранение значения в кэше Сохраняет элемент в кэше по ключу. Да Да Да Да Да
Удаление значения из кэша Удаляет элемент в кэше по ключу. Да Да Да Да Да
Получение кэшированных ответов запросов API Azure OpenAI Выполняет поиск в кэше API OpenAI Azure с помощью семантического поиска и возвращает допустимый кэшированный ответ при наличии. Да Да Да Да Нет
Хранение ответов запросов API OpenAI Azure для кэширования Кэширует ответ в соответствии с конфигурацией кэша API Azure OpenAI. Да Да Да Да Нет
Получение кэшированных ответов запросов API большой языковой модели Выполняет поиск в кэше API большой языковой модели с помощью семантического поиска и возвращает допустимый кэшированный ответ при наличии. Да Да Да Да Нет
Хранение ответов на запросы API большой языковой модели для кэширования Кэширует ответ в соответствии с конфигурацией кэша API крупной языковой модели. Да Да Да Да Нет

Преобразование

Политика Описание Классическое Версия 2 Потребление Самостоятельный хостинг Рабочая область
Установка метода запроса Позволяет изменить метод HTTP для запроса. Да Да Да Да Да
Установка кода состояния Изменяет код состояния HTTP на указанное значение. Да Да Да Да Да
Установка переменной Сохраняет значение в именованной переменной контекста для последующего доступа. Да Да Да Да Да
Установить основной текст Задает текст сообщения для запроса или ответа. Да Да Да Да Да
Настройка заголовка HTTP Назначает значение имеющемуся заголовку ответа и/или запроса либо добавляет новый заголовок ответа и/или запроса. Да Да Да Да Да
Установка параметра строки запроса Добавляет, заменяет значение или удаляет параметр строки запроса. Да Да Да Да Да
Переопределение URL-адреса Преобразует URL-адрес запроса из его общедоступной формы в форму, ожидаемую веб-службой. Да Да Да Да Да
Преобразование JSON в XML Преобразует текст запроса или ответа из JSON в XML. Да Да Да Да Да
Преобразование XML в JSON Преобразует текст запроса или ответа из XML в JSON. Да Да Да Да Да
Поиск и замена строки в тексте Находит подстроку запроса или ответа и заменяет ее на другую подстроку. Да Да Да Да Да
URL-адреса маски в содержимом Перезаписывает (маскирует) ссылки в теле ответа, чтобы они указывали на эквивалентную ссылку, проходяющую через шлюз. Да Да Да Да Да
Преобразование XML с помощью XSLT Применяет преобразование XSL к XML в тексте запроса или ответа. Да Да Да Да Да
Возвращаемый ответ Прерывает выполнение конвейера и возвращает указанный ответ напрямую вызывающему. Да Да Да Да Да
Макет ответа Прерывает выполнение конвейера и возвращает смоделированный ответ напрямую вызывающему. Да Да Да Да Да

Междоменный

Политика Описание Классическое Версия 2 Потребление Самостоятельный хостинг Рабочая область
Разрешить междоменные вызовы Делает API доступным для клиентов на основе браузера Adobe Flash и Microsoft Silverlight. Да Да Да Да Да
CORS Добавляет поддержку междоменного доступа к ресурсам (CORS) в операцию или API для выполнения кросс-доменных вызовов клиентами на основе браузера. Да Да Да Да Да
JSONP Добавляет поддержку JSON с заполнением (JSONP) в операцию или API, чтобы разрешить кросс-доменные запросы от клиентов на основе браузера JavaScript. Да Да Да Да Да

Интеграция и внешнее взаимодействие

Политика Описание Классическое Версия 2 Потребление Самостоятельный хостинг Рабочая область
Отправка запроса Отправляет запрос на указанный URL-адрес. Да Да Да Да Да
Отправка односторонного запроса Отправляет запрос на указанный URL-адрес, не ожидая ответа. Да Да Да Да Да
Вход в концентратор событий Отправляет сообщения в указанном формате в концентратор событий, определённый объектом логгера. Да Да Да Да Да
Отправка запроса в службу (Dapr) Использует среду выполнения Dapr для поиска и надежного взаимодействия с микрослужбой Dapr. Дополнительные сведения о вызове службы в Dapr см. в описании в этом файле README . Нет Нет Нет Да Нет
Отправка сообщения в раздел Pub/Sub (Dapr) Использует среду выполнения Dapr для публикации сообщения в разделе публикации и подписки. Дополнительные сведения о сообщении о публикации и подписке в Dapr см. в описании в этом файле README . Нет Нет Нет Да Нет
Триггер выходной привязки (Dapr) Использует среду выполнения Dapr для вызова внешней системы через выходную привязку. Дополнительные сведения о привязках в Dapr см. в описании в этом файле README . Нет Нет Нет Да Нет

Ведение журнала

Политика Описание Классическое Версия 2 Потребление Самостоятельный хостинг Рабочая область
Трассировка Добавляет пользовательские трассировки в вывод трассировки запросов в тестовой консоли, телеметрию Application Insights и журналы ресурсов. Да Да1 Да Да Да
Выдача метрик Отправляет пользовательские метрики в Application Insights во время выполнения. Да Да Да Да Да
Выдача метрик токена Azure OpenAI Отправляет метрики в Application Insights для использования токенов больших языковых моделей через API службы Azure OpenAI. Да Да Нет Да Да
Собирать метрики токенов API для крупной языковой модели Отправляет метрики в Application Insights для использования маркеров большой языковой модели (LLM) через API LLM. Да Да Нет Да Да

1 В шлюзе версии 2 trace политика в настоящее время не добавляет результаты трассировки в тестовую консоль.

Резолверы GraphQL

Политика Описание Классическое Версия 2 Потребление Самостоятельный хостинг Рабочая область
Источник данных SQL Azure для сопоставителя Настраивает запрос SQL Azure и необязательный ответ для разрешения данных типа объекта и поля в схеме GraphQL. Да Да Нет Нет Нет
Источник данных Cosmos DB для сопоставителя Настраивает запрос Cosmos DB и необязательный ответ для разрешения данных для типа объекта и поля в схеме GraphQL. Да Да Нет Нет Нет
Источник данных HTTP для сопоставителя Настраивает HTTP-запрос и при необходимости HTTP-ответ для разрешения данных для типа объекта и поля в схеме GraphQL. Да Да Да Нет Нет
Публикация события в подписке GraphQL Публикует событие в одну или несколько подписок, указанных в схеме API GraphQL. Настройте политику в резолвере GraphQL для связанного поля в схеме для другого типа операции, например мутации. Да Да Да Нет Нет

Шлюз искусственного интеллекта

Политика Описание Классическое Версия 2 Потребление Самостоятельный хостинг Рабочая область
Ограничение использования маркера службы OpenAI в Azure Предотвращает пики использования API OpenAI Azure, ограничивая количество токенов крупных языковых моделей на вычисляемый ключ. Да Да Нет Да Да
Ограничение использования маркера API для крупной языковой модели Предотвращает пики использования API больших языковых моделей (LLM), ограничивая количество токенов LLM на вычисляемый ключ. Да Да Нет Да Да
Выдача метрик токена Azure OpenAI Отправляет метрики в Application Insights для использования токенов больших языковых моделей через API службы Azure OpenAI. Да Да Нет Да Да
Собирать метрики токенов API для крупной языковой модели Отправляет метрики в Application Insights для использования маркеров большой языковой модели (LLM) через API LLM. Да Да Нет Да Да
Получение кэшированных ответов запросов API Azure OpenAI Выполняет поиск в кэше API OpenAI Azure с помощью семантического поиска и возвращает допустимый кэшированный ответ при наличии. Да Да Да Да Нет
Получение кэшированных ответов запросов API большой языковой модели Выполняет поиск в кэше API большой языковой модели с помощью семантического поиска и возвращает допустимый кэшированный ответ при наличии. Да Да Да Да Нет
Хранение ответов запросов API OpenAI Azure для кэширования Кэширует ответ в соответствии с конфигурацией кэша API Azure OpenAI. Да Да Да Да Нет
Хранение ответов на запросы API большой языковой модели для кэширования Кэширует ответ в соответствии с конфигурацией кэша API крупной языковой модели. Да Да Да Да Нет
Принудительное применение проверок безопасности содержимого для запросов LLM Обеспечивает проверку безопасности содержимого запросов LLM, передавая их в службу безопасности содержимого Azure AI прежде чем отправить в серверную часть LLM. Да Да Да Да Да

Управление политикой и поток данных

Политика Описание Классическое Версия 2 Потребление Самостоятельный хостинг Рабочая область
Поток управления Условно применяет утверждения политики на основе результатов оценки логических выражений. Да Да Да Да Да
Включение фрагмента Вставляет фрагмент политики в определение политики. Да Да Да Да Да
Снова пробовать Повторите выполнение вложенных инструкций политики, если и до тех пор, пока условие не будет выполнено. Выполнение будет повторяться через определенные промежутки времени и до указанного количества повторных попыток. Да Да Да Да Да
Ждать Ожидает завершения закрытого запроса отправки, получения значения из кэша или политик потока управления , прежде чем продолжить. Да Да Да Да Да

Связанный контент

Дополнительные сведения о работе с политиками см. в нижеуказанных статьях.