Postup při nastavení nebo úpravě zásad služby Azure API Management

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

V tomto článku se dozvíte, jak nakonfigurovat zásady v instanci služby API Management úpravou definic zásad na webu Azure Portal. Každá definice zásady je dokument XML, který popisuje posloupnost příchozích a odchozích příkazů, které se sekvenčně spouštějí na požadavku a odpovědi rozhraní API.

Editor zásad na portálu poskytuje pro vydavatele rozhraní API řízené formuláře pro přidávání a úpravy zásad v definicích zásad. Kód XML můžete také upravit přímo v editoru kódu zásad.

Další informace o zásadách:

• Přehled zásad
• Referenční informace o zásadách pro úplný seznam prohlášení o zásadách a jejich nastavení
• Úložiště fragmentů zásad
• Sada nástrojů zásad služby Azure API Management
• Vytváření zásad pomocí Microsoft Copilotu v Azure

Požadavky

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

• Vytvoření instance Azure API Managementu
• Import a publikování rozhraní API

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

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

   

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

   

Konfigurace zásad na portálu

Následující příklad ukazuje, jak nakonfigurovat zásadu pomocí dvou možností v editoru zásad na portálu:

• Editor založený na formulářích s asistencí pro zjednodušení konfigurace mnoha zásad
• Editor kódu, ve kterém můžete přímo přidávat nebo upravovat XML

V tomto příkladu zásady filtruje požadavky z určitých příchozích IP adres. Je vymezený na vybrané rozhraní API.

Poznámka:

Zásady můžete nakonfigurovat v jiných oborech, například pro všechna rozhraní API, produkt nebo jednu operaci rozhraní API. Další příklady najdete v části Konfigurace oboru dále v tomto článku.

Konfigurace zásad:

Formulář

1. V levém navigačním panelu instance služby API Management vyberte rozhraní API.

2. Vyberte rozhraní API, které jste předtím naimportovali.

3. Vyberte kartu Návrh.

4. Pokud chcete zásadu použít pro všechny operace, vyberte Všechny operace.

5. V části Zpracování příchozích dat vyberte + Přidat zásadu.

   

6. V části Přidat příchozí zásady vyberte zásadu, která se má přidat. Vyberte například Filtrovat IP adresy.

   

   Tip

   • Zobrazené zásady se vztahují na oddíl zásad, který konfigurujete – v tomto případě pro příchozí zpracování.
   • Pokud nevidíte požadovanou zásadu, vyberte dlaždici Další zásady . Otevře se editor kódu XML a zobrazí se úplný seznam zásad pro daný oddíl a obor.

7. Vyberte Povolené IP> adresy+ Přidat filtr IP adres a přidejte první a poslední IP adresy rozsahu příchozích adres, které mají povolené požadavky rozhraní API. V případě potřeby přidejte další rozsahy IP adres.

   

8. Výběrem možnosti Uložit rozšíříte změny do brány služby API Management okamžitě.

   Zásady filtru IP se teď zobrazují v části Zpracování příchozích dat .

Kód

1. V levém navigačním panelu instance služby API Management vyberte rozhraní API.

2. Vyberte rozhraní API, které jste předtím naimportovali.

3. Vyberte kartu Návrh.

4. Pokud chcete zásadu použít pro všechny operace, vyberte Všechny operace.

5. V části Zpracování příchozích dat vyberte <ikonu /> (editor kódu).

   

6. Pokud chcete zobrazit dostupné fragmenty kódu XML zásad, vyberte Zobrazit fragmenty kódu. Vyberte například Omezit IP adresy volajícího.

   

7. Vložte nebo zadejte fragment kódu požadované zásady do jednoho z příslušných bloků a dokončete konfiguraci zásad.

   <policies>
       <inbound>
           <base />
           <ip-filter action="allow">
               <address-range from="10.100.7.0" to="10.100.127.0" />
           </ip-filter>
       </inbound>
       <backend>
           <base />
       </backend>
       <outbound>
           <base />
       </outbound>
       <on-error>
           <base />
       </on-error>
   </policies>
   

   Poznámka:

   Nastavte prvky zásad a podřízené prvky v pořadí uvedeném v prohlášení o zásadách.

8. Výběrem možnosti Uložit rozšíříte změny do brány služby API Management okamžitě.

   Zásady filtru IP se teď zobrazují v části Zpracování příchozích dat .

Konfigurace zásad v různých oborech

Služba API Management poskytuje flexibilitu při konfiguraci definic zásad v několika oborech v každé části zásad.

Důležité

Ne všechny zásady se dají použít v každém oboru nebo oddílu zásad. Pokud není zásada, kterou chcete přidat, povolená, ujistěte se, že jste v části s podporovanými zásadami a rozsahem pro tuto zásadu. Pokud chcete zkontrolovat oddíly a rozsahy zásad, projděte si část Použití v referenčních tématech o zásadách.

Poznámka:

Oddíl zásady back-endu může obsahovat pouze jeden prvek zásady. Ve výchozím nastavení služba API Management nakonfiguruje forward-request zásady v back-endovém oddílu v globálním oboru a base element v jiných oborech.

Globální obor

Globální obor je nakonfigurovaný pro všechna rozhraní API ve vaší instanci služby API Management.

1. V levém navigačním panelu instance služby API Management vyberte rozhraní API>Všechna rozhraní API.

2. Vyberte kartu Návrh.

   

3. V části zásady vyberte + Přidat zásadu pro použití editoru zásad založený na formuláři nebo vyberte <ikonu /> (editor kódu) a přidejte a upravte XML přímo.

4. Výběrem možnosti Uložit rozšíříte změny do brány služby API Management okamžitě.

Rozsah produktu

Obor produktu je nakonfigurovaný pro vybraný produkt.

1. V nabídce vlevo vyberte Produkty a pak vyberte produkt, na který chcete použít zásady.

2. V okně produktu vyberte Zásady.

   

3. V části zásady vyberte + Přidat zásadu pro použití editoru zásad založený na formuláři nebo vyberte <ikonu /> (editor kódu) a přidejte a upravte XML přímo.

4. Výběrem možnosti Uložit rozšíříte změny do brány služby API Management okamžitě.

Rozsah rozhraní API

Obor rozhraní API je nakonfigurovaný pro všechny operace vybraného rozhraní API.

1. V levém navigačním panelu vaší instance služby API Management vyberte rozhraní API a pak vyberte rozhraní API, na které chcete zásady použít.

2. Vyberte kartu Návrh.

3. Vyberte Všechny operace.

   

4. V části zásady vyberte + Přidat zásadu pro použití editoru zásad založený na formuláři nebo vyberte <ikonu /> (editor kódu) a přidejte a upravte XML přímo.

5. Výběrem možnosti Uložit rozšíříte změny do brány služby API Management okamžitě.

Rozsah operace

Obor operace je nakonfigurovaný pro vybranou operaci rozhraní API.

1. V levém navigačním panelu instance služby API Management vyberte rozhraní API.

2. Vyberte kartu Návrh.

3. Vyberte operaci, na kterou chcete použít zásady.

   

4. V části zásady vyberte + Přidat zásadu pro použití editoru zásad založený na formuláři nebo vyberte <ikonu /> (editor kódu) a přidejte a upravte XML přímo.

5. Výběrem možnosti Uložit rozšíříte změny do brány služby API Management okamžitě.

Opakované použití konfigurací zásad

V instanci služby API Management můžete vytvořit opakovaně použitelné fragmenty zásad. Fragmenty zásad jsou elementy XML obsahující vaše konfigurace jedné nebo více zásad. 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.

Použijte zásadu include-fragment k vložení fragmentu zásady do definice zásady.

Nastavení pořadí vyhodnocení zásad pomocí base elementu

Pokud konfigurujete definice zásad ve více než jednom oboru, může se na požadavek nebo odpověď rozhraní API použít více zásad. V závislosti na pořadí použití zásad z různých oborů se transformace požadavku nebo odpovědi může lišit.

Ve službě API Management určete pořadí vyhodnocení zásad umístěním base prvku v každé části definice zásady v každém oboru. Element base dědí zásady nakonfigurované v této části v dalším širším (nadřazené) oboru. Tento base prvek je ve výchozím nastavení součástí každé části zásad.

Poznámka:

Pokud chcete zobrazit efektivní zásady v aktuálním oboru, vyberte v editoru zásad možnost Vypočítat efektivní zásady .

Úprava pořadí vyhodnocení zásad pomocí editoru zásad:

1. Začněte definicí s nejužším oborem, který jste nakonfigurovali, který api Management použije jako první.

   Například při použití definic zásad nakonfigurovaných v globálním oboru a oboru rozhraní API začněte konfigurací v oboru rozhraní API.

2. base Umístěte prvek do oddílu a určete, kde dědit všechny zásady z odpovídajícího oddílu v nadřazené oblasti.

   Například v inbound části nakonfigurované v oboru rozhraní API umístěte base prvek, který určuje, kde dědit zásady nakonfigurované v oddílu inbound v globálním oboru. V následujícím příkladu se zásady zděděné z globálního oboru použijí před zásadou ip-filter .

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

   Poznámka:

   • Prvek můžete umístit base před nebo za libovolný prvek zásady v oddílu.
   • Pokud chcete zabránit dědění zásad z nadřazeného oboru, odeberte base element. Ve většině případů se to nedoporučuje.

3. Pokračujte v konfiguraci elementu base v definicích zásad v postupně širších oborech.

   Globálně vymezené zásady nemají žádný nadřazený obor a použití base prvku v něm nemá žádný vliv.

Získání pomoci s vytvářením zásad pomocí Microsoft Copilotu v Azure (Preview)

Microsoft Copilot v Azure (Preview) poskytuje možnosti vytváření zásad pro Azure API Management. Pomocí Copilotu v Azure v kontextu editoru zásad služby API Management můžete vytvářet zásady, které odpovídají vašim konkrétním požadavkům, aniž byste znali syntaxi nebo už jste nakonfigurovali zásady.

Můžete vyzvat Copilot v Azure, aby vygeneroval definice zásad, pak výsledky zkopírujte do editoru zásad a proveďte potřebné úpravy. Položte otázky, abyste získali přehled o různých možnostech, upravili poskytnuté zásady nebo objasnili zásady, které už máte. Další informace

Související obsah

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

• Kurz: Transformace a ochrana rozhraní API
• Nastavení nebo úprava zásad
• referenční příručce o zásadách
• Úložiště fragmentů zásad
• Sada nástrojů zásad služby Azure API Management
• Vytváření zásad pomocí Microsoft Copilotu v Azure