Настройка или изменение политик службы управления API Azure

  • Статья

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

В этой статье показано, как настроить политики в экземпляре службы "Управление API" путем изменения определений политик на портале Azure. Каждое определение политики представляет собой XML-документ, описывающий последовательность входящих и исходящих инструкций, которые выполняются последовательно в запросе и ответе API.

Редактор политик на портале предоставляет интерактивные формы для издателей API, с помощью которых можно добавлять и изменять политики в определениях политик. Вы также можете изменить XML непосредственно в редакторе кода политики.

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

Необходимые компоненты

Если у вас еще нет экземпляра службы "Управление API" и API серверной части, см. следующие статьи:

Перейдите к экземпляру службы управления API.

  1. На портале Azure найдите и выберите службы Управление API.

    Выбор

  2. На странице Службы Управления API выберите экземпляр Управления API.

    Выбор экземпляра службы

Настройка политики на портале

В следующем примере показано, как настроить политику с помощью двух вариантов в редакторе политик на портале:

  • Интерактивный редактор на основе форм для упрощенной настройки многих политик.
  • Редактор кода, в котором можно добавлять или редактировать XML напрямую.

В этом примере политика фильтрует запросы от определенных входящих IP-адресов. Она ограничена выбранным API.

Примечание.

Политики можно настроить с другими областями, например для всех API, продукта или одной операции API. Другие примеры см. далее в этой статье в разделе Настройка области.

Чтобы настроить политику, сделайте следующее:

  1. В области навигации экземпляра Управления API слева выберите API.

  2. Выберите ранее импортированный API.

  3. Выберите вкладку Конструктор.

  4. Чтобы применить политику ко всем операциям, выберите Все операции.

  5. В разделе Обработка входящих данных выберите + Добавить политику.

    Добавление политики в Управление API

  6. В разделе Добавление политики входящих запросов выберите нужную политику, например Фильтрация IP-адресов.

    Фильтрация политики IP-адресов

    Совет

    • Отображаемые политики относятся к настраиваемому разделу политики, в этом случае для обработки входящих запросов.
    • Если вы не видите нужную политику, выберите плитку Другие политики. Откроется редактор кода XML и отобразится полный список политик для этого раздела и области.

  7. Выберите Разрешенные IP-адреса>+ Добавить фильтр IP-адресов и добавьте первый и последний IP-адреса диапазона входящих адресов, которым разрешено выполнять запросы API. При необходимости добавьте другие диапазоны IP-адресов.

    Настройка разрешенных IP-адресов

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

    Политика ip-filter отобразится в разделе Обработка входящих запросов.

Настройка политик в различных областях

Управление API позволяет гибко настраивать определения политик в нескольких областях в каждом из разделов политик.

Внимание

Не все политики можно применять в каждой области или каждом разделе политики. Если политика, которую требуется добавить, не включена, убедитесь, что вы находитесь в поддерживаемых разделе и области для этой политики. Чтобы просмотреть разделы политики и области ее действия, ознакомьтесь с разделом Использование в справочнике по политикам.

Примечание.

Раздел политики Серверная часть может содержать только один элемент политики. По умолчанию Управление API настраивает политику forward-request в разделе Серверная часть в глобальной области и элемент base в других областях.

Глобальная область

Глобальная область настраивается для всех API в экземпляре службы "Управление API".

  1. В области навигации экземпляра Управления API слева выберите API>Все API.

  2. Выберите вкладку Конструктор.

    Настройка политики в область продукта

  3. В разделе политики выберите + Добавить политику, чтобы воспользоваться редактором политик на основе форм, или выберите значок </> (редактор кода), чтобы напрямую добавить и изменить код XML.

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

Область продукта

Область продукта настраивается для выбранного продукта.

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

  2. В окне продукта выберите Политики.

    Настройка политики в глобальной область

  3. В разделе политики выберите + Добавить политику, чтобы воспользоваться редактором политик на основе форм, или выберите значок </> (редактор кода), чтобы напрямую добавить и изменить код XML.

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

Область API

Область API настраивается для всех операций выбранного API.

  1. В левой области навигации экземпляра Управления API выберите API и выберите API, к которому вы хотите применить политики.

  2. Выберите вкладку Конструктор.

  3. Выберите Все операции.

    Настройка политики в область API

  4. В разделе политики выберите + Добавить политику, чтобы воспользоваться редактором политик на основе форм, или выберите значок </> (редактор кода), чтобы напрямую добавить и изменить код XML.

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

Область операций

Область операций настраивается для выбранной операции API.

  1. В области навигации экземпляра Управления API слева выберите API.

  2. Выберите вкладку Конструктор.

  3. Выберите операцию, к которой нужно применить политики.

    Настройка политики при выполнении область

  4. В разделе политики выберите + Добавить политику, чтобы воспользоваться редактором политик на основе форм, или выберите значок </> (редактор кода), чтобы напрямую добавить и изменить код XML.

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

Повторное использование конфигураций политик

Вы можете создавать многократно используемые фрагменты политики в экземпляре API Management. Фрагменты политики имеют формат XML и содержат конфигурации для одной или нескольких политик. Фрагменты политик помогают согласованно настраивать политики и обслуживать определения политик без необходимости повторного использования или ввода XML-кода.

Используйте политику include-fragment для вставки фрагмента политики в определение политики.

Использование элемента base для настройки порядка оценки политик

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

В Управлении API определите порядок оценки политик, поместив элемент base в каждом разделе определения политики в каждой области. Элемент base наследует политики, настроенные в этом разделе, в следующей более широкой (родительской) области. Элемент base включается по умолчанию в каждый раздел политики.

Примечание.

Чтобы просмотреть действующие политики в текущей области, выберите Вычислить действующую политику в редакторе политик.

Чтобы изменить порядок оценки политик с помощью редактора политик, сделайте следующее:

  1. Начните с определения в самой узкой настроенной области, которое Управление API будет применять первым.

    Например, при использовании определений политик, настроенных в глобальной области и области API, начните с настройки в области API.

  2. Поместите элемент base в раздел, чтобы определить, где наследовать все политики из соответствующего раздела в родительской области.

    Например, в разделе inbound, настроенном в области API, поместите элемент base для управления тем, где следует наследовать политики, настроенные в разделе inbound в глобальной области. В следующем примере политики, унаследованные от глобальной области, применяются перед политикой ip-filter.

    <policies>
  <inbound>
      <base />
        <ip-filter action="allow">
            <address>10.100.7.1</address>
        </ip-filter>
  </inbound>
  [...]
</policies>

    Примечание.

    • Элемент base можно разместить до или после любого элемента политики в разделе.
    • Если вы хотите запретить наследование политик из родительской области, удалите элемент base. Но в большинстве случаев это не рекомендуется.

  3. Продолжите настройку элемента base в определениях политик в более широких областях.

    Для политики с глобальной областью не существует родительской области, поэтому использовать в ней элемент base бесполезно.

Получение помощи в создании политик с помощью Microsoft Copilot для Azure (предварительная версия)

Microsoft Copilot для Azure (предварительная версия) предоставляет возможности разработки политик для Управление API Azure. Используйте Copilot для Azure в контексте редактора политик Управление API, чтобы создавать политики, соответствующие определенным требованиям, не зная синтаксиса или уже настроенные политики.

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

Внимание

Microsoft Copilot для Azure (предварительная версия) требует регистрации и в настоящее время доступен только утвержденным корпоративным клиентам и партнерам. Дополнительные сведения см. в статье "Ограниченный доступ к Microsoft Copilot для Azure (предварительная версия)".

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

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