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

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

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

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

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

• Общие сведения о политике
• Полный список политик и их параметров можно найти в справочном разделе.
• Репозиторий фрагментов политик
• Набор средств политики Azure API Management
• Политики авторов с использованием Microsoft Copilot в Azure

Предварительные условия

Если у вас еще нет экземпляра управления API и API бэкенда, обратитесь к:

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

Go to your API Management instance

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

   

2. On the API Management services page, select your API Management instance:

   

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

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

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

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

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

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

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

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

Global scope is configured for All APIs in your API Management instance.

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

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

   

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

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

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

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

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

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

   

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

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

Область API

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

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

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

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

   

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

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

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

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

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

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

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

   

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

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

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

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

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

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

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

В Управлении API определите порядок оценки политик, поместив элемент base в каждом разделе определения политики в каждой области. The base element inherits the policies configured in that section at the next broader (parent) scope. Элемент base включается по умолчанию в каждый раздел политики.

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

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

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

2. Place the base element within a section to determine where to inherit all policies from the corresponding section at the parent scope.

   Например, в разделе inbound, конфигурируемом в области API, поместите элемент base, чтобы управлять тем, где наследуются политики, настроенные в разделе inbound в глобальной области. In the following example, policies inherited from the global scope are applied before the ip-filter policy.

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

   Примечание.

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

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

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

Воспользуйтесь помощью Copilot

Получите помощь по искусственному интеллекту от Copilot, чтобы создать и изменить определения политики управления API. С помощью Copilot создайте и обновите политики, соответствующие определенным требованиям, не зная синтаксис XML, и получите объяснения существующих политик. Copilot также может помочь вам перевести политики, которые могли быть настроены в других решениях по управлению API.

• Microsoft Copilot in Azure - предлагает помощь в создании политик с использованием подсказок на естественном языке в портале Azure. Создайте политики в редакторе политик управления API и попросите Copilot объяснить разделы политики.
• GitHub Copilot для Azure в VS Code - предоставляет поддержку авторства политик в Visual Studio Code, ускоряя настройку политик при использовании расширения Azure API Management для Visual Studio Code. Prompt Copilot Chat or Copilot Edits (preview) with natural language to create and refine policy definitions in place.

Пример запроса:

Generate a policy that adds an Authorization header to the request with a Bearer token.

Copilot работает на основе искусственного интеллекта, поэтому возможны сюрпризы и ошибки. For more information, see Copilot general use FAQs.

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

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

• Руководство: Преобразование и защита API
• Полный список политик и их параметров можно найти в справочном разделе.
• Выражения политики
• Настройка или изменение политик
• Повторное использование конфигураций политик
• Репозиторий фрагментов политик
• Набор средств политики Azure API Management
• Получите помощь Copilot для создания, объяснения и устранения неполадок в политике