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

  • Статья

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

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

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

Внимание

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

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

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

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

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

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

Политика Description Классическое V2 Потребление Самостоятельное размещение
Проверка содержимого Проверяет размер или содержимое текста запроса или ответа на одну или несколько схем API. Поддерживаемые форматы схемы — JSON и XML. Да Да Да Да
Проверка запроса GraphQL Проверяет и авторизует запрос к API GraphQL. Да Да Да Да
Проверка запроса OData Проверяет запрос к API OData, чтобы обеспечить соответствие спецификации OData. Да Да Да Да
Проверка параметров Проверяет заголовок запроса, запрос или параметры пути к схеме API. Да Да Да Да
Проверка заголовков Проверяет заголовки ответа на схему API. Да Да Да Да
Проверка кода состояния Проверяет коды состояния HTTP в ответах на схему API. Да Да Да Да

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

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

Кэширование

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

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

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

Междоменная область

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

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

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

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

Политика Description Классическое V2 Потребление Самостоятельное размещение
Трассировка Добавляет пользовательские трассировки в выходные данные трассировки запросов в тестовой консоли, телеметрии Application Insights и журналы ресурсов. Да Да1 Да Да
Выдача метрик Отправляет пользовательские метрики в Application Insights при выполнении. Да Да Да Да
Выдача метрик токена Azure OpenAI Отправляет метрики в Application Insights для потребления больших маркеров языковой модели через API-интерфейсы службы Azure OpenAI. Да Да No Да
Метрики маркеров маркера api для крупной языковой модели Отправляет метрики в Application Insights для использования маркеров большой языковой модели (LLM) через API LLM. Да Да No Да

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

Сопоставители GraphQL

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

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

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

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

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