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

PLATÍ PRO: Všechny úrovně správy rozhraní API

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
• Stanovování 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 portálu Azure 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 omezený na vybrané 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. Viz Konfigurace rozsahu, dále v tomto článku, pro další příklady.

Pro konfiguraci zásad:

Formulář

1. V levé navigaci své instance Správy rozhraní API 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 Přidat příchozí zásady vyberte zásadu k přidání. Například vyberte Filtrovat IP adresy.

   

   Návod

   • 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 a přidejte první a poslední IP adresy z rozsahu příchozích adres, které mají povoleno provádět požadavky na 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é navigaci své instance Správy rozhraní API 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 a podřízené prvky zásady ve 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. Chcete-li zkontrolovat sekce a rozsahy zásady, podívejte se na část Použití v tématech Odkaz na zásady.

Poznámka:

Oddíl zásady back-endu může obsahovat pouze jeden prvek zásady. Ve výchozím nastavení konfiguruje API Management politiku forward-request v sekci Backend na globální úrovni a prvek base v ostatních úrovních.

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é navigaci své instance Správy rozhraní API 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ě.

Znovu použít konfigurace 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 nadřazeném (širším) rozsahu. 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 a 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. Umístěte prvek base do oddílu, abyste určili, kde se budou dědit všechny zásady z odpovídajícího oddílu v nadřazené oblasti.

   Například v části inbound, která je nakonfigurována na úrovni API, vložte prvek base k řízení, kde se mají dědit politiky nakonfigurované v části inbound na globální úrovni. 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:

   • Můžete umístit prvek base před nebo za jakýkoli prvek zásad v rámci sekce.
   • 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. V určitých situacích ale může být užitečné, například když chcete použít různé zásady na konkrétní operaci, než je nakonfigurované pro obor rozhraní API (všechny operace).

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ískejte asistenci Copilota

Pomoc s AI můžete získat od společnosti Copilot k vytvoření a úpravě definic zásad služby API Management. Pomocí Copilotu můžete vytvářet a aktualizovat zásady, které odpovídají vašim konkrétním požadavkům, aniž byste museli znát syntaxi XML. Můžete také získat vysvětlení existujících zásad. A Copilot vám může pomoct přeložit zásady, které jste možná nakonfigurovali v jiných řešeních služby API Management.

• Microsoft Copilot v Azure poskytuje pomoc při vytváření zásad s výzvami v přirozeném jazyce na webu Azure Portal. Máte možnost vytvářet zásady v editoru zásad služby API Management a požádat Copilota o vysvětlení sekcí zásad.
• GitHub Copilot pro Azure v editoru Visual Studio Code poskytuje pomoc při vytváření zásad v editoru Visual Studio Code a ke zrychlení konfigurace zásad můžete použít rozšíření Azure API Management pro Visual Studio Code . Můžete použít funkce Copilot Chat nebo Copilot Edits s přirozeným jazykem k vytváření a upřesňování definic zásad.

Příklad výzvy:

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

Copilot využívá AI, takže překvapení a chyby jsou možné. Další informace najdete v tématu Nejčastější dotazy k obecnému použití copilotu.

Související obsah

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

• Kurz: Transformace a ochrana rozhraní API
• Referenční informace o zásadách pro úplný seznam prohlášení o zásadách a jejich nastavení
• Výrazy zásad
• Nastavení nebo úprava zásad
• Znovu použít konfigurace zásad
• Úložiště fragmentů zásad
• Úložiště dětského hřiště zásad
• Sada nástrojů zásad služby Azure API Management
• Získejte asistenci Copilotu při vytváření, vysvětlování a řešení problémů se zásadami.