Справочник по политикам службы управления API
В этом разделе приведены ссылки на справочные статьи для всех политик Управления API.
Дополнительные сведения о политиках:
Важно!
Ограничение частоты вызовов по подписке и задание квоты использования по подписке имеют зависимость от ключа подписки. Ключ подписки не требуется при применении других политик.
Политики ограничения доступа
- Проверка HTTP-заголовка —обеспечивает принудительное создание заголовка и (или) его значения.
- Получение контекста авторизации — возвращает контекст указанной авторизации, настроенной в экземпляре службы управления API.
- Ограничение частоты вызовов по подписке — предотвращает пики использования API, ограничивая частоту вызовов для каждой подписки.
- Ограничение частоты вызовов по ключу — предотвращает пики использования API, ограничивая частоту вызовов по ключу.
- Ограничение IP-адресов вызывающих объектов – фильтрует (разрешает или запрещает) вызовы с конкретных IP-адресов и/или диапазонов адресов.
- Задание квоты использования по подписке — позволяет принудительно устанавливать возобновляемую или действующую в течение срока службы квоту на число вызовов и (или) квоту пропускной способности для каждой подписки.
- Задание квоты использования по ключу — позволяет принудительно устанавливать возобновляемую или действующую в течение срока службы квоту на число вызовов и (или) квоту пропускной способности для каждого ключа.
- Проверка маркера Azure Active Directory — обеспечивает наличие и допустимость JWT Azure Active Directory, извлеченного из указанного заголовка HTTP, параметра запроса или значения маркера.
- Проверка JWT — обеспечивает существование и допустимость JWT, извлеченного из указанного заголовка HTTP, параметра запроса или значения токена.
- Проверка сертификата клиента — проверяет соответствие сертификата, предоставленного клиентом экземпляру API управления, указанным правилам проверки и утверждениям.
Расширенные политики
- Управление потоками — условно применяет правила политики на основе результатов вычисления логических выражений.
- Выдача метрик — отправляет пользовательские метрики в Application Insights во время выполнения.
- Перенаправляющий запрос — перенаправляет запрос в серверную службу.
- Включение фрагмента — вставляет фрагмент политики в определение политики.
- Ограничения параллелизма не позволяет, чтобы заключенные политики одновременно выполнялись запросами, количество которых выше указанного.
- Регистрация в концентраторе событий — отправляет сообщения в концентратор событий, который указан сущностью Logger.
- Макетирование ответа —прекращает выполнение конвейера и возвращает макетированный ответ непосредственно вызывающему объекту.
- Повторить — повторяет выполнение инструкций встраиваемой политики, если не выполнено условие и до тех пор пока оно не будет выполнено. Выполнение будет повторяться через определенные промежутки времени и до указанного количества повторных попыток.
- Возврат ответа —прекращает выполнение конвейера и возвращает указанный ответ непосредственно вызывающему объекту.
- Отправка одностороннего запроса —отправляет запрос на указанный URL-адрес и не ожидает ответа.
- Отправка запроса —отправляет запрос на указанный URL-адрес.
- Установка прокси-сервера HTTP — позволяет маршрутизировать перенаправленные запросы через прокси-сервер HTTP.
- Установка метода запроса — позволяет изменить метод HTTP для запроса.
- Установка кода состояния — меняет код состояния HTTP на указанное значение.
- Задание переменной — сохраняет значение в именованной переменной контекста для последующего использования.
- Трассировка — добавляет пользовательские трассировки в выходные данные трассировки запросов в консоли тестирования, в телеметрии Application Insights и в журналы ресурсов.
- Ожидание — ожидает завершения вложенных политик отправки запроса, получения значения из кэша или управления потоком перед продолжением.
Политики аутентификации
- Обычная проверка подлинности – обычная проверка подлинности внутренней службы.
- Аутентификация с помощью сертификата клиента – аутентификация внутренней службы с помощью сертификатов клиентов.
- Аутентификация с помощью управляемого удостоверения — аутентификация в серверной службе с помощью управляемого удостоверения.
Политики кэширования
- Получение из кэша — выполнение поиска в кэше и возврат допустимого кэшированного ответа при его наличии.
- Сохранение в кэше – помещение в кэш ответа в соответствии с заданной конфигурацией управления кэшем.
- Получение значения из кэша — получение кэшированного элемента по ключу.
- Сохранение значения в кэше —сохранение элемента в кэше по ключу.
- Удалить значение из кэша — удаление элемента в кэше по ключу.
Междоменные политики
- Разрешение кросс-доменных вызовов – делает API доступным из клиентов на основе браузеров Adobe Flash и Microsoft Silverlight.
- CORS – добавляет поддержку общего доступа к ресурсам независимо от источника (CORS) для операции или API, чтобы разрешить кросс-доменные вызовы от клиентов на основе браузера.
- JSONP – добавляет поддержку JSON с заполнением (JSONP) для операции или API, чтобы разрешить кросс-доменные вызовы из браузерных клиентов JavaScript.
Политики интеграции с Dapr
- Отправить запрос в службу — использование среды выполнения Dapr для обнаружения микрослужбы Dapr и установления надежной связи с ней. Дополнительные сведения о вызове службы в Dapr см. в описании в этом файле сведений.
- Отправить сообщение в раздел публикации и подписки — использование среды выполнения Dapr для публикации сообщения в разделе публикации и подписки. Дополнительные сведения об отправке сообщений в раздел публикации и подписки в Dapr см. в описании в этом файле сведений.
- Активировать выходную привязку — использование среды выполнения Dapr для вызова внешней системы через выходную привязку. Дополнительные сведения о привязках в Dapr см. в описании в этом файле сведений.
Политики API GraphQL
- Проверка запроса GraphQL — проверяет и авторизует запрос к API GraphQL.
- Установка сопоставителя GraphQL — извлекает или задает данные для поля GraphQL в типе объекта, указанном в схеме GraphQL.
Политики преобразования
- Преобразование JSON в XML —преобразует текст запроса или ответа в формате JSON в формат XML.
- Преобразование XML в JSON —преобразует текст запроса или ответа в формате XML в формат JSON.
- Поиск и замена строки в тексте —позволяет найти подстроку запроса или ответа и заменить ее на другую подстроку.
- Маскировка URL-адресов в содержимом — перезаписывает (маскирует) ссылки в тексте ответа так, чтобы каждая из них указывала на эквивалентную ссылку через шлюз.
- Задание внутренней службы – изменяет внутреннюю службу для входящего запроса.
- Задание текста – задает текст сообщения для входящих и исходящих запросов.
- Установка HTTP-заголовка -– назначает значение существующему заголовку ответа и/или запроса или добавляет новый заголовок ответа и/или запроса.
- Настройка параметра строки запроса - добавляет, заменяет значение или удаляет параметр строки запроса.
- Перезапись URL-адреса —преобразовывает URL-адрес запроса из его общедоступной формы в форму, ожидаемую веб-службой.
- Преобразование XML с помощью XSLT — применяет преобразование данных в формате XSL в формат XML в тексте запроса или ответа.
Политики проверки
- Проверка содержимого — проверяет размер или содержимое запроса или ответа на одну или несколько схем API. Поддерживаемые форматы схемы — JSON и XML.
- Проверка параметров — проверяет параметры заголовка запроса, запроса или пути на соответствие схеме API.
- Проверка заголовков — проверяет заголовки ответов на соответствие схеме API.
- Проверка кода состояния — проверяет коды состояния HTTP в
Дальнейшие действия
Дополнительные сведения о работе с политиками см. в нижеуказанных статьях.