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

  • Статья

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

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

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

Фрагмент политики:

  • должен быть допустимым XML-кодом, содержащим одну или несколько конфигураций политик;
  • может включать в себя выражения политики, если указанная в ссылке политика их поддерживает;
  • вставляется в исходном виде в определение политики с помощью политики include-fragment.

Ограничения:

  • Фрагмент политики не может содержать идентификатор раздела политики (<inbound>, <outbound> и т. д.) или элемент <base/>.
  • Сейчас фрагмент политики не может вкладывать другой фрагмент политики.
  • Максимальный размер фрагмента политики составляет 32 КБ.

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

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

Хотя это и не требуется, можно настроить одно или несколько определений политик. Вы можете скопировать элементы политики из этих определений при создании фрагментов политики.

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

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

    Выбор

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

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

Создание фрагмента политики

  1. В левой области навигации вашего экземпляра Управления API в разделе API-интерфейсы выберите Фрагменты политики>+ Создать.

  2. В окне Создание фрагмента политики введите Имя и необязательное Описание фрагмента политики. Имя должно быть уникальным в пределах вашего экземпляра Управления API.

    Пример имени: ForwardContext.

  3. В редакторе Фрагмент политики XML введите или вставьте один или несколько XML-элементов политики между тегами <fragment> и </fragment>.

    Снимок экрана: форма создания фрагмента политики.

    Например, следующий фрагмент содержит конфигурацию политики set-header для пересылки сведений о контексте во внутреннюю службу. Этот фрагмент будет включен в раздел политики входящего трафика. Выражения политики в этом примере обращаются к встроенной переменной context.

    <fragment>
    <set-header name="x-request-context-data" exists-action="override">
      <value>@(context.User.Id)</value>
      <value>@(context.Deployment.Region)</value>
    </set-header>
</fragment>

  4. Нажмите кнопку создания. Фрагмент добавляется в список фрагментов политики.

Включение фрагмента в определение политики

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

  • Вы можете включить фрагмент в любую область и в любой раздел политики, если базовая политика или базовые политики во фрагменте поддерживают такое использование.
  • В определение политики можно включить несколько фрагментов политики.

Например, вставьте фрагмент политики ForwardContext в раздел политики входящего трафика:

<policies>
    <inbound>
        <include-fragment fragment-id="ForwardContext" />
        <base />
    </inbound>
[...]

Совет

Чтобы просмотреть содержимое включенного фрагмента в определении политики выберите Calculate effective policy (Вычислить эффективную политику) в редакторе политик.

Управление фрагментами политики

Созданный фрагмент политики можно в любое время удалить либо просмотреть и изменить его свойства.

Просмотр свойств фрагмента политики:

  1. В левой области навигации вашего экземпляра Управления API в разделе API-интерфейсы выберите Фрагменты политики. Выберите имя фрагмента.
  2. На странице Обзор перейдите в область Ссылки в документах политики, чтобы просмотреть определения политик, содержащие этот фрагмент.
  3. На странице Свойства просмотрите имя и описание фрагмента политики. Изменить это имя невозможно.

Изменение фрагмента политики:

  1. В левой области навигации вашего экземпляра Управления API в разделе API-интерфейсы выберите Фрагменты политики. Выберите имя фрагмента.
  2. Выберите Редактор политик.
  3. Измените операторы во фрагменте и нажмите кнопку Применить.

Примечание.

Изменение затрагивает все определения политик, в которые включен этот фрагмент.

Удаление фрагмента политики:

  1. В левой области навигации вашего экземпляра Управления API в разделе API-интерфейсы выберите Фрагменты политики. Выберите имя фрагмента.
  2. Просмотрите Ссылки в документах политики для определений политик, содержащих этот фрагмент. Перед удалением фрагмента необходимо удалить ссылки на него из всех определений политик.
  3. После удаления всех ссылок нажмите кнопку Удалить.

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

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