Opakované použití konfigurací zásad v definicích zásad služby API Management

  • Článek

PLATÍ PRO: Všechny úrovně služby API Management

V tomto článku se dozvíte, jak vytvářet a používat fragmenty zásad v definicích zásad služby API Management. Fragmenty zásad jsou centrálně spravované a opakovaně použitelné fragmenty kódu XML obsahující jednu nebo více konfigurací zásad služby API Management.

Fragmenty zásad pomáhají konzistentně konfigurovat zásady a udržovat definice zásad bez nutnosti opakovat nebo znovu zadávat kód XML.

Fragment zásad:

  • Musí být platný KÓD XML obsahující jednu nebo více konfigurací zásad.
  • Může obsahovat výrazy zásad, pokud je odkazovaná zásada podporuje.
  • Vloží se tak, jak je v definici zásady, pomocí zásady zahrnutí fragmentu.

Omezení:

  • Fragment zásady nemůže obsahovat identifikátor oddílu zásad (<inbound><outbound>atd.) ani <base/> prvek.
  • V současné době fragment zásad nemůže vnořit další fragment zásad.
  • Maximální velikost fragmentu zásad je 32 kB.

Požadavky

Pokud ještě nemáte instanci služby API Management a back-endové rozhraní API, přečtěte si téma:

I když to není nutné, možná budete chtít nakonfigurovat jednu nebo více definic zásad. Při vytváření fragmentů zásad můžete z těchto definic kopírovat prvky zásad.

Přejít k instanci služby API Management

  1. Na webu Azure Portal vyhledejte a vyberte služby API Management.

    Výběr služeb API Management

  2. Na stránce služby API Management vyberte instanci služby API Management.

    Výběr instance služby API Management

Vytvoření fragmentu zásad

  1. V levém navigačním panelu vaší instance služby API Management v části Rozhraní API vyberte Fragmenty> zásad + Vytvořit.

  2. V okně Vytvořit nový fragment zásad zadejte název a volitelný popis fragmentu zásady. Název musí být jedinečný v rámci vaší instance služby API Management.

    Příklad názvu: ForwardContext

  3. V editoru fragmentů zásad XML zadejte nebo vložte jeden nebo více elementů XML zásad mezi a <fragment></fragment> značky.

    Snímek obrazovky znázorňující formulář pro vytvoření nového fragmentu zásad

    Následující fragment obsahuje set-header například konfiguraci zásad pro předávání kontextových informací back-endové službě. Tento fragment by se zahrnul do oddílu příchozích zásad. Výrazy zásad v tomto příkladu přistupují k předdefinované context proměnné.

    <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. Vyberte Vytvořit. Fragment se přidá do seznamu fragmentů zásad.

Zahrnutí fragmentu do definice zásady

Nakonfigurujte zásadu include-fragment tak, aby v definici zásady vložil fragment zásad. Další informace o definicích zásad najdete v tématu Nastavení nebo úprava zásad.

  • Fragment můžete zahrnout v libovolném rozsahu a v jakékoli části zásad, pokud podkladové zásady nebo zásady podporují toto použití.
  • Do definice zásady můžete zahrnout více fragmentů zásad.

Například vložte fragment zásady s názvem ForwardContext do oddílu příchozích zásad:

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

Tip

Pokud chcete zobrazit obsah zahrnutého fragmentu zobrazeného v definici zásady, vyberte v editoru zásad vypočítat efektivní zásadu .

Správa fragmentů zásad

Po vytvoření fragmentu zásad můžete zobrazit a aktualizovat vlastnosti fragmentu zásady nebo kdykoli odstranit fragment zásady.

Zobrazení vlastností fragmentu zásady:

  1. V levém navigačním panelu vaší instance služby API Management v části Rozhraní API vyberte fragmenty zásad. Vyberte název fragmentu.
  2. Na stránce Přehled si prohlédněte odkazy na dokument Zásady a podívejte se na definice zásad, které obsahují fragment.
  3. Na stránce Vlastnosti zkontrolujte název a popis fragmentu zásady. Název nelze změnit.

Úprava fragmentu zásad:

  1. V levém navigačním panelu vaší instance služby API Management v části Rozhraní API vyberte fragmenty zásad. Vyberte název fragmentu.
  2. Vyberte Editor zásad.
  3. Aktualizujte příkazy v fragmentu a pak vyberte Použít.

Poznámka:

Aktualizace ovlivňuje všechny definice zásad, ve kterých je fragment zahrnutý.

Odstranění fragmentu zásad:

  1. V levém navigačním panelu vaší instance služby API Management v části Rozhraní API vyberte fragmenty zásad. Vyberte název fragmentu.
  2. Projděte si referenční informace k dokumentům zásad pro definice zásad, které obsahují fragment. Před odstraněním fragmentu je nutné odebrat odkazy na fragment ze všech definic zásad.
  3. Po odebrání všech odkazů vyberte Odstranit.

Související obsah

Další informace o práci se zásadami najdete v tématech: