Azure API Management-szabályzatok beállítása és szerkesztése

A KÖVETKEZŐRE VONATKOZIK: Minden API Management-szint

Ez a cikk bemutatja, hogyan konfigurálhat szabályzatokat az API Management-példányban a szabályzatdefiníciók Azure Portalon történő szerkesztésével. Minden szabályzatdefiníció egy XML-dokumentum, amely az API-kéréseken és -válaszokon egymás után futó bejövő és kimenő utasítások sorozatát írja le.

A portál szabályzatszerkesztője interaktív űrlapokat biztosít az API-közzétevők számára a szabályzatok szabályzatdefiníciókban való hozzáadásához és szerkesztéséhez. Az XML-t közvetlenül a szabályzatkódszerkesztőben is szerkesztheti.

További információ a szabályzatokról:

• Szabályzat áttekintése
• Szabályzathivatkozás a szabályzatutasságok és azok beállításainak teljes listájához
• Szabályzatrészletek adattára

Előfeltételek

Ha még nem rendelkezik API Management-példánysal és háttér API-val, tekintse meg a következőt:

• Azure API Management-példány létrehozása
• API importálása és közzététele

Nyissa meg az API Management-példányát

1. Az Azure Portalon keresse meg és válassza ki az API Management-szolgáltatásokat.

   

2. Az API Management-szolgáltatások lapon válassza ki az API Management-példányt.

   

Szabályzat konfigurálása a portálon

Az alábbi példa bemutatja, hogyan konfigurálhat egy szabályzatot két lehetőséggel a portál házirendszerkesztőjében:

• Irányított űrlapalapú szerkesztő számos szabályzat konfigurálásának leegyszerűsítéséhez
• Kódszerkesztő, amelybe közvetlenül felvehet vagy szerkeszthet XML-t

Ebben a példában a szabályzat bizonyos bejövő IP-címekről érkező kéréseket szűr. Hatóköre egy kijelölt API-ra van korlátozva.

Feljegyzés

A szabályzatokat más hatókörökben is konfigurálhatja, például az összes API-hoz, egy termékhez vagy egyetlen API-művelethez. További példákért tekintse meg a hatókör konfigurálását a cikk későbbi részében.

Szabályzat konfigurálása:

Űrlap

1. Az API Management-példány bal oldali navigációs sávjában válassza az API-kat.

2. Válasszon ki egy korábban importált API-t.

3. Válassza ki a Tervezés fület.

4. Ha a szabályzatot az összes műveletre szeretné alkalmazni, válassza a Minden művelet lehetőséget.

5. A Bejövő feldolgozás szakaszban válassza a + Szabályzat hozzáadása lehetőséget.

   

6. A Bejövő házirend hozzáadása területen válassza ki a hozzáadni kívánt szabályzatot. Válassza például az IP-címek szűrése lehetőséget.

   

   Tipp.

   • A megjelenített szabályzatok hatóköre a konfigurálni kívánt szabályzatszakaszra terjed ki – ebben az esetben a bejövő feldolgozáshoz.
   • Ha nem látja a kívánt szabályzatot, válassza az Egyéb szabályzatok csempét. Ezzel megnyitja az XML-kódszerkesztőt, és megjeleníti az adott szakaszra és hatókörre vonatkozó szabályzatok teljes listáját.

7. Válassza az Engedélyezett IP-címek>+ IP-szűrő hozzáadása lehetőséget, és adja hozzá az API-kérésekhez engedélyezett bejövő címek tartományának első és utolsó IP-címét. Szükség esetén adjon hozzá más IP-címtartományokat.

   

8. A Mentés gombra kattintva azonnal propagálja a módosításokat az API Management-átjárón.

   Az IP-szűrési szabályzat most megjelenik a Bejövő feldolgozás szakaszban.

Kód

1. Az API Management-példány bal oldali navigációs sávjában válassza az API-kat.

2. Válasszon ki egy korábban importált API-t.

3. Válassza ki a Tervezés fület.

4. Ha a szabályzatot az összes műveletre szeretné alkalmazni, válassza a Minden művelet lehetőséget.

5. A Bejövő feldolgozás szakaszban válassza a </> (kódszerkesztő) ikont.

   

6. Az elérhető szabályzat XML-kódrészleteinek megtekintéséhez válassza a Kódrészletek megjelenítése lehetőséget. Válassza például a hívó IP-címeinek korlátozása lehetőséget.

   

7. Illessze be vagy írja be a kívánt szabályzatkódrészletet az egyik megfelelő blokkba, és fejezze be a szabályzatkonfigurációt.

   <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>
   

   Feljegyzés

   Állítsa be a szabályzat elemeit és gyermekelemeit a szabályzatutasításban megadott sorrendben.

8. A Mentés gombra kattintva azonnal propagálja a módosításokat az API Management-átjárón.

   Az IP-szűrési szabályzat most megjelenik a Bejövő feldolgozás szakaszban.

Szabályzatok konfigurálása különböző hatókörökben

Az API Management rugalmasan konfigurálja a szabályzatdefiníciókat több hatókörben, az egyes szabályzatszakaszokban.

Fontos

Nem minden szabályzat alkalmazható minden hatókörre vagy szabályzatszakaszra. Ha a hozzáadni kívánt szabályzat nincs engedélyezve, győződjön meg arról, hogy a szabályzat támogatott szakaszában és hatókörében van. A szabályzatok szabályzatszakaszainak és hatóköreinek áttekintéséhez tekintse át a Szabályzat referenciatémakörök Használati szakaszát.

Feljegyzés

A Háttérházirend szakasz csak egy házirendelemet tartalmazhat. Az API Management alapértelmezés szerint konfigurálja a forward-requestglobális hatókör Háttérszakaszában lévő szabályzatot, valamint az base elemet más hatókörökben.

Globális hatókör

A globális hatókör az API Management-példány összes API-jához konfigurálva van.

1. Az API Management-példány bal oldali navigációs sávjában válassza az API-k minden API-ját>.

2. Válassza ki a Tervezés fület.

   

3. A szabályzatszakaszban válassza a + Szabályzat hozzáadása lehetőséget űrlapalapú szabályzatszerkesztő használatához, vagy válassza a </> (kódszerkesztő) ikont az XML közvetlen hozzáadásához és szerkesztéséhez.

4. A Mentés gombra kattintva azonnal propagálja a módosításokat az API Management-átjárón.

Termék hatóköre

A termék hatóköre egy kiválasztott termékhez van konfigurálva.

1. A bal oldali menüben válassza a Termékek lehetőséget, majd válassza ki azt a terméket, amelyre szabályzatokat szeretne alkalmazni.

2. A termékablakban válassza a Szabályzatok lehetőséget.

   

3. A szabályzatszakaszban válassza a + Szabályzat hozzáadása lehetőséget űrlapalapú szabályzatszerkesztő használatához, vagy válassza a </> (kódszerkesztő) ikont az XML közvetlen hozzáadásához és szerkesztéséhez.

4. A Mentés gombra kattintva azonnal propagálja a módosításokat az API Management-átjárón.

API-hatókör

Az API-hatókör a kiválasztott API minden műveletéhez konfigurálva van.

1. Az API Management-példány bal oldali navigációs sávjában válassza ki az API-kat, majd válassza ki azt az API-t, amelyhez szabályzatokat szeretne alkalmazni.

2. Válassza ki a Tervezés fület.

3. Válassza a Minden művelet lehetőséget.

   

4. A szabályzatszakaszban válassza a + Szabályzat hozzáadása lehetőséget űrlapalapú szabályzatszerkesztő használatához, vagy válassza a </> (kódszerkesztő) ikont az XML közvetlen hozzáadásához és szerkesztéséhez.

5. A Mentés gombra kattintva azonnal propagálja a módosításokat az API Management-átjárón.

Művelet hatóköre

A művelet hatóköre egy kijelölt API-művelethez van konfigurálva.

1. Az API Management-példány bal oldali navigációs sávjában válassza az API-kat.

2. Válassza ki a Tervezés fület.

3. Válassza ki azt a műveletet, amelyre szabályzatokat szeretne alkalmazni.

   

4. A szabályzatszakaszban válassza a + Szabályzat hozzáadása lehetőséget űrlapalapú szabályzatszerkesztő használatához, vagy válassza a </> (kódszerkesztő) ikont az XML közvetlen hozzáadásához és szerkesztéséhez.

5. A Mentés gombra kattintva azonnal propagálja a módosításokat az API Management-átjárón.

Szabályzatkonfigurációk újrafelhasználása

Az API Management-példányban újrafelhasználható szabályzattöredékeket hozhat létre. A szabályzattöredékek olyan XML-elemek, amelyek egy vagy több szabályzat konfigurációit tartalmazzák. A szabályzattöredékek segítenek a szabályzatok konzisztens konfigurálásában és a szabályzatdefiníciók fenntartásában az XML-kód ismétlése vagy újraírása nélkül.

include-fragment A szabályzat használatával szabályzattöredékeket szúrhat be egy szabályzatdefinícióba.

Elem használata base a szabályzatok kiértékelési sorrendjének beállításához

Ha egynél több hatókörben konfigurálja a szabályzatdefiníciókat, több szabályzat is alkalmazható egy API-kérésre vagy -válaszra. A különböző hatókörök házirendjeinek alkalmazásának sorrendjétől függően a kérés vagy válasz átalakítása eltérhet.

Az API Managementben az egyes hatókörökben a szabályzatdefiníció egyes szakaszaiban található elem elhelyezésével base határozza meg a szabályzat-kiértékelési sorrendet. Az base elem örökli az ebben a szakaszban konfigurált szabályzatokat a következő szélesebb körű (szülő)hatókörben. Az base elem alapértelmezés szerint szerepel az egyes szabályzatszakaszokban.

Feljegyzés

Az aktuális hatókörben érvényes szabályzatok megtekintéséhez válassza a Szabályzatszerkesztőben az Érvényes szabályzat kiszámítása lehetőséget.

A szabályzat kiértékelési sorrendjének módosítása a szabályzatszerkesztővel:

1. Kezdje a definícióval a konfigurált legszűkebb hatókörben, amely az API Managementet fogja először alkalmazni.

   Ha például a globális hatókörben és az API-hatókörben konfigurált szabályzatdefiníciókat használja, kezdje a konfigurációval az API-hatókörben.

2. Helyezze az base elemet egy szakaszba annak meghatározásához, hogy hol örökölje az összes házirendet a szülőhatókör megfelelő szakaszából.

   Az API-hatókörben inbound konfigurált szakaszban például helyezzen el egy base elemet, ahová a globális hatókörben inbound konfigurált szakaszban konfigurált szabályzatokat örökölheti. Az alábbi példában a globális hatókörből öröklő szabályzatok a szabályzat előtt ip-filter lesznek alkalmazva.

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

   Feljegyzés

   • Az elemet a base szakasz bármely szabályzateleme elé vagy mögé helyezheti.
   • Ha meg szeretné akadályozni, hogy a házirendek öröklődjenek a szülőhatókörből, távolítsa el az base elemet. A legtöbb esetben ez nem ajánlott.

3. Folytassa a base szabályzatdefiníciók elemének konfigurálását az egymást követő szélesebb hatókörökben.

   A globális hatókörű szabályzatok nem rendelkezik szülőhatókörrel, és az base elem használata nincs hatással.

Segítség kérése szabályzatok létrehozásához az Azure-hoz készült Microsoft Copilot használatával (előzetes verzió)

Az Azure-hoz készült Microsoft Copilot (előzetes verzió) szabályzatkészítési képességeket biztosít az Azure API Managementhez. Az API Management szabályzatszerkesztőjének kontextusában használja az Azure-hoz készült Copilotot az adott követelményeknek megfelelő szabályzatok létrehozásához anélkül, hogy ismerné a szintaxist, vagy már konfigurálta a szabályzatokat.

Megkérheti a Copilototot az Azure-hoz, hogy hozzon létre szabályzatdefiníciókat, majd másolja az eredményeket a szabályzatszerkesztőbe, és végezze el a szükséges módosításokat. Kérdéseket tehet fel a különböző lehetőségek megismeréséhez, a megadott szabályzat módosításához vagy a már meglévő szabályzat tisztázásához. Tudj meg többet

Fontos

Az Azure-hoz készült Microsoft Copilot (előzetes verzió) regisztrációt igényel, és jelenleg csak jóváhagyott nagyvállalati ügyfelek és partnerek számára érhető el. További információ: Korlátozott hozzáférés az Azure-hoz készült Microsoft Copilothoz (előzetes verzió).

Kapcsolódó tartalom

A szabályzatok használatával kapcsolatos további információkért lásd:

• Oktatóanyag: API-k átalakítása és védelme
• Házirendek beállítása vagy szerkesztése
• Szabályzathivatkozás a szabályzatutasságok és azok beállításainak teljes listájához
• Szabályzatrészletek adattára
• Szabályzatok létrehozása az Azure-hoz készült Microsoft Copilot használatával