Azure API Management ポリシーの設定または編集方法

ポリシー定義は、一連の受信ステートメントと送信ステートメントが記述された XML ドキュメントです。 XML は、定義ウィンドウで直接編集できます。 ポリシー ウィンドウの右側に表示される一覧から定義済みのポリシーを選ぶこともできます。 現在のスコープに適用可能なステートメントは有効になり、強調表示されます。 有効なステートメントをクリックすると、定義ビュー内のカーソル位置に適切な XML が追加されます。

ポリシーについて詳しくは、「Azure API Management のポリシー」をご覧ください。

ポリシーの設定または編集

ポリシーを設定または編集するには、次の手順に従います。

  1. Azure Portal (https://portal.azure.com) にサインインします。

  2. APIM インスタンスを参照します。

  3. [API] タブをクリックします。

    ポリシーを編集する

  4. 前にインポートした API の 1 つを選びます。

  5. [デザイン] タブを選択します。

  6. ポリシーを適用する操作を選びます。 すべての操作にポリシーを適用する場合は、[すべての操作] を選択します。

  7. [受信処理] または [送信処理] セクションで、 </> (コード エディター) アイコンを選択します。

  8. 目的のポリシー コードを適切なブロックのいずれかに貼り付けます。

    <policies>
        <inbound>
            <base />
        </inbound>
        <backend>
            <base />
        </backend>
        <outbound>
            <base />
        </outbound>
        <on-error>
            <base />
        </on-error>
    </policies>
    

スコープの構成

ポリシーは、グローバルに構成することも、成果物、API、または操作をスコープとして構成することもできます。 ポリシーの構成を開始するには、ポリシーを適用するスコープを最初に選択する必要があります。

ポリシー スコープは、次の順序で評価されます。

  1. グローバル スコープ
  2. 成果物スコープ
  3. API スコープ
  4. 操作スコープ

ポリシーに含まれるステートメントは、base 要素が存在する場合は、その配置に従って評価されます。 グローバル ポリシーには親ポリシーがないため、<base> 要素を使用しても効果はありません。

現在のスコープに含まれるポリシーをポリシー エディターに表示するには、 [選択したスコープの有効なポリシーを再計算する] をクリックします。

グローバル スコープ

グローバル スコープが APIM インスタンス内の [すべての API] に対して構成されます。

  1. Azure Portal にサインインし、APIM インスタンスに移動します。

  2. [すべての API] をクリックします。

    グローバル スコープ

  3. 三角形のアイコンをクリックします。

  4. [コード エディター] を選択します。

  5. ポリシーを追加または編集します。

  6. [保存] をクリックします。

    API Management ゲートウェイに変更が直ちに反映されます。

成果物スコープ

成果物スコープは、選択した成果物に対して構成されます。

  1. [成果物] をクリックします。

    成果物スコープ

  2. ポリシーを適用する成果物を選びます。

  3. [ポリシー] をクリックします。

  4. ポリシーを追加または編集します。

  5. [保存] をクリックします。

API スコープ

API スコープは、選択した API の [すべての操作] に対して構成されます。

  1. ポリシーを適用する API を選びます。

    API スコープ

  2. [すべての操作] を選択します

  3. 三角形のアイコンをクリックします。

  4. [コード エディター] を選択します。

  5. ポリシーを追加または編集します。

  6. [保存] をクリックします。

操作スコープ

操作スコープは、選択した操作に対して構成されます。

  1. API を選びます。

  2. ポリシーを適用する操作を選びます。

    操作スコープ

  3. 三角形のアイコンをクリックします。

  4. [コード エディター] を選択します。

  5. ポリシーを追加または編集します。

  6. [保存] をクリックします。

次の手順

次の関連トピックをご覧ください。