API Management ポリシー定義でポリシー構成を再利用する

適用対象: すべての API Management レベル

この記事では、API Management ポリシー定義で ''ポリシーフラグメント'' を作成して使用する方法を示します。ポリシーフラグメントは、1 つまたは複数の API Management ポリシー構成を含む、一元管理される再利用可能な XML スニペットです。

ポリシーフラグメントは、ポリシーを一貫して構成し、XML コードを繰り返したり、再入力したりする必要なくポリシー定義を維持するのに役立ちます。

ポリシーフラグメント:

制限事項:

ポリシーフラグメントには、ポリシーセクション識別子 (<inbound>、<outbound> など) や <base/> 要素を含めることはできません。
現在、ポリシーフラグメントでは別のポリシーフラグメントを入れ子にすることはできません。
ポリシーフラグメントの最大サイズは 32 KB です。

前提条件

API Management インスタンスとバックエンド API がまだない場合は、次をご覧ください。

必須ではありませんが、1 つまたは複数のポリシー定義を構成する必要がある場合があります。ポリシーフラグメントを作成するときに、これらの定義からポリシー要素をコピーできます。

API Management インスタンスの左側のナビゲーションにある [API] で、[ポリシーフラグメント]>[+ 作成] を選択します。
[新しいポリシーフラグメントの作成] ウィンドウで、ポリシーフラグメントの [名前] とオプションの [説明] を入力します。名前は、API Management インスタンス内で一意である必要があります。

名前の例: ForwardContext
XML ポリシーフラグメント エディターで、1 つまたは複数のポリシー XML 要素を <fragment> と </fragment> タグの間に入力するか貼り付けます。

たとえば、次のフラグメントには、バックエンドサービスにコンテキスト情報を転送する set-header ポリシー構成が含まれています。このフラグメントは受信ポリシーセクションに含まれます。この例のポリシー式では、組み込みの context 変数にアクセスします。
```
<fragment>
    <set-header name="x-request-context-data" exists-action="override">
      <value>@(context.User.Id)</value>
      <value>@(context.Deployment.Region)</value>
    </set-header>
</fragment>
```
［作成］ を選択しますフラグメントがポリシーフラグメントの一覧に追加されます。

ポリシー定義にポリシーフラグメントを挿入するように include-fragment ポリシーを構成します。ポリシー定義の詳細については、「ポリシーの設定または編集」をご覧ください。

たとえば、受信ポリシーセクションに ForwardContext という名前のポリシーフラグメントを挿入します。

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

ヒント

ポリシー定義に表示される含まれているフラグメントの内容を確認するには、ポリシーエディターで [有効なポリシーの計算] を選択します。

ポリシーフラグメントを作成した後は、いつでもポリシーフラグメントのプロパティを表示し、更新し、ポリシーフラグメントを削除できます。

ポリシーフラグメントのプロパティを表示するには:

API Management インスタンスの左側のナビゲーションで、[API] の下にある [ポリシーフラグメント] を選択します。フラグメントの名前を選択します。
[概要] ページで、ポリシードキュメントの参照を確認し、フラグメントを含むポリシー定義を確かめます。
[プロパティ] ページで、ポリシーフラグメントの名前と説明を確認します。名前を変更することはできません。

ポリシーフラグメントを編集するには:

API Management インスタンスの左側のナビゲーションで、[API] の下にある [ポリシーフラグメント] を選択します。フラグメントの名前を選択します。
[ポリシーエディター] を選択します。
フラグメント内のステートメントを更新してから、[適用] を選択します。

注意

更新は、フラグメントが含まれるすべてのポリシー定義に影響します。

ポリシーフラグメントを削除するには:

API Management インスタンスの左側のナビゲーションで、[API] の下にある [ポリシーフラグメント] を選択します。フラグメントの名前を選択します。
フラグメントを含むポリシー定義に関するポリシードキュメントの参照を確認します。フラグメントを削除するには、事前にすべてのポリシー定義からフラグメント参照を削除する必要があります。
すべての参照が削除された後、[削除] を選択します。

ポリシーに対する処理の詳細については、次のトピックを参照してください。