Szabályzatkonfigurációk újrafelhasználása az API Management-szabályzatdefiníciókban

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

Ez a cikk bemutatja, hogyan hozhat létre és használhat szabályzattöredékeket az API Management-szabályzatdefiníciókban. A szabályzattöredékek központilag felügyelt, újrafelhasználható XML-kódrészletek, amelyek egy vagy több API Management-szabályzatkonfigurációt tartalmaznak.

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.

Szabályzattöredék:

• Érvényes XML-nek kell lennie, amely egy vagy több szabályzatkonfigurációt tartalmaz
• Tartalmazhat szabályzatkifejezéseket, ha egy hivatkozott szabályzat támogatja őket
• Az is-ként van beszúrva egy szabályzatdefinícióba a belefoglalási töredék szabályzat használatával

Korlátozások:

• A szabályzatrészletek nem tartalmazhatnak szabályzatszakasz-azonosítót (<inbound>stb <outbound>.) vagy <base/> elemet.
• Egy szabályzattöredék jelenleg nem tud beágyazni egy másik szabályzattöredéket.
• A szabályzattöredékek maximális mérete 32 KB.

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

Bár nem kötelező, érdemes lehet egy vagy több szabályzatdefiníciót konfigurálni . Szabályzatelemeket másolhat ezekből a definíciókból szabályzattöredékek létrehozásakor.

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ályzattöredék létrehozása

1. Az API Management-példány bal oldali navigációs sávjában, az API-k alatt válassza a Szabályzattöredékek>+ Létrehozás lehetőséget.

2. Az Új szabályzattöredék létrehozása ablakban adja meg a szabályzattöredék nevét és opcionális leírását. A névnek egyedinek kell lennie az API Management-példányon belül.

   Példa neve: ForwardContext

3. Az XML-szabályzattöredékszerkesztőbe írjon be vagy illessze be egy vagy több szabályzat XML-elemét a <fragment> címkék közé</fragment>.

   

   Az alábbi töredék például tartalmaz egy szabályzatkonfigurációt set-header , amely környezeti információkat továbbít egy háttérszolgáltatásnak. Ez a töredék egy bejövő szabályzatszakaszban szerepelne. A példában szereplő szabályzatkifejezések a beépített context változóhoz férnek hozzá.

   <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. Válassza a Létrehozás lehetőséget. A rendszer hozzáadja a töredékeket a szabályzattöredékek listájához.

Töredék belefoglalása egy szabályzatdefinícióba

Konfigurálja a include-fragment szabályzatot úgy, hogy egy szabályzattöredéket szúrjon be egy szabályzatdefinícióba. A szabályzatdefiníciókkal kapcsolatos további információkért lásd: Szabályzatok beállítása vagy szerkesztése.

• A töredékeket bármilyen hatókörbe és bármely szabályzatszakaszba belefoglalhatja, amennyiben a töredékben lévő mögöttes szabályzat vagy szabályzatok támogatják ezt a használatot.
• Egy szabályzatdefinícióban több szabályzattöredék is szerepelhet.

Szúrja be például a ForwardContext nevű szabályzattöredéket a bejövő házirendszakaszba:

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

Tipp.

Ha meg szeretné tekinteni a szabályzatdefinícióban megjelenített belefoglalt töredék tartalmát, válassza az Érvényes szabályzat kiszámítása lehetőséget a szabályzatszerkesztőben.

Szabályzattöredékek kezelése

A szabályzattöredék létrehozása után bármikor megtekintheti és frissítheti egy szabályzattöredék tulajdonságait, vagy bármikor törölheti a szabályzattöredéket.

Szabályzattöredék tulajdonságainak megtekintése:

1. Az API Management-példány bal oldali navigációs sávjában, az API-k alatt válassza a Szabályzattöredékek lehetőséget. Válassza ki a töredék nevét.
2. Az Áttekintés lapon tekintse át a szabályzatdokumentum hivatkozásait a töredéket tartalmazó szabályzatdefiníciók megtekintéséhez.
3. A Tulajdonságok lapon tekintse át a szabályzattöredék nevét és leírását. A név nem módosítható.

Szabályzattöredék szerkesztése:

1. Az API Management-példány bal oldali navigációs sávjában, az API-k alatt válassza a Szabályzattöredékek lehetőséget. Válassza ki a töredék nevét.
2. Válassza a Szabályzatszerkesztő lehetőséget.
3. Frissítse a töredékben lévő utasításokat, majd válassza az Alkalmaz lehetőséget.

Feljegyzés

A frissítés az összes olyan szabályzatdefinícióra hatással van, amelyben a töredék szerepel.

Szabályzattöredék törlése:

1. Az API Management-példány bal oldali navigációs sávjában, az API-k alatt válassza a Szabályzattöredékek lehetőséget. Válassza ki a töredék nevét.
2. Tekintse át a töredéket tartalmazó szabályzatdefiníciók szabályzatdokumentum-hivatkozásait . A töredék törlése előtt el kell távolítania a töredékhivatkozásokat az összes szabályzatdefinícióból.
3. Miután az összes hivatkozás el lett távolítva, válassza a Törlés lehetőséget.

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 teljes listájához
• Szabályzatrészletek adattára
• Szabályzatok létrehozása a Microsoft Copilot használatával az Azure-ban