Azure API Management ポリシーの設定または編集方法How to set or edit Azure API Management policies

ポリシー定義は、一連の受信ステートメントと送信ステートメントが記述された XML ドキュメントです。The policy definition is an XML document that describes a sequence of inbound and outbound statements. XML は、定義ウィンドウで直接編集できます。The XML can be edited directly in the definition window. ポリシー ウィンドウの右側に表示される一覧から定義済みのポリシーを選ぶこともできます。You can also select a predefined policy from the list that is provided to the right of the policy window. 現在のスコープに適用可能なステートメントは有効になり、強調表示されます。The statements applicable to the current scope are enabled and highlighted. 有効なステートメントをクリックすると、定義ビュー内のカーソル位置に適切な XML が追加されます。Clicking an enabled statement adds the appropriate XML at the location of the cursor in the definition view.

ポリシーについて詳しくは、「Azure API Management のポリシー」をご覧ください。For detailed information about policies, see Policies in Azure API Management.

ポリシーの設定または編集Set or edit a policy

ポリシーを設定または編集するには、次の手順に従います。To set or edit a policy, follow the following steps:

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

  2. APIM インスタンスを参照します。Browse to your APIM instance.

  3. [API] タブをクリックします。Click the APIs tab.

    ポリシーを編集する

  4. 前にインポートした API の 1 つを選びます。Select one of the APIs that you previously imported.

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

  6. ポリシーを適用する操作を選びます。Select an operation to which you want to apply the policy. すべての操作にポリシーを適用する場合は、 [すべての操作] を選択します。If you want to apply the policy to all operations, select All operations.

  7. [受信処理] または [送信処理] セクションで、 </> (コード エディター) アイコンを選択します。Select the </> (code editor) icon in the Inbound processing or Outbound processing section.

  8. 目的のポリシー コードを適切なブロックのいずれかに貼り付けます。Paste the desired policy code into one of the appropriate blocks.

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

スコープの構成Configure scope

ポリシーは、グローバルに構成することも、成果物、API、または操作をスコープとして構成することもできます。Policies can be configured globally or at the scope of a Product, API, or Operation. ポリシーの構成を開始するには、ポリシーを適用するスコープを最初に選択する必要があります。To begin configuring a policy, you must first select the scope at which the policy should apply.

ポリシー スコープは、次の順序で評価されます。Policy scopes are evaluated in the following order:

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

ポリシーに含まれるステートメントは、base 要素が存在する場合は、その配置に従って評価されます。The statements within policies are evaluated according to the placement of the base element, if it is present. グローバル ポリシーには親ポリシーがないため、<base> 要素を使用しても効果はありません。Global policy has no parent policy and using the <base> element in it has no effect.

現在のスコープに含まれるポリシーをポリシー エディターに表示するには、 [選択したスコープの有効なポリシーを再計算する] をクリックします。To see the policies in the current scope in the policy editor, click Recalculate effective policy for selected scope.

グローバル スコープGlobal scope

グローバル スコープが APIM インスタンス内の [すべての API] に対して構成されます。Global scope is configured for All APIs in your APIM instance.

  1. Azure Portal にサインインし、APIM インスタンスに移動します。Sign in to the Azure portal and navigate to your APIM instance.

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

    グローバル スコープ

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

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

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

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

    API Management ゲートウェイに変更が直ちに反映されます。The changes are propagated to the API Management gateway immediately.

成果物スコープProduct scope

成果物スコープは、選択した成果物に対して構成されます。Product scope is configured for the selected product.

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

    成果物スコープ

  2. ポリシーを適用する成果物を選びます。Select the product to which you want to apply policies.

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

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

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

API スコープAPI scope

API スコープは、選択した API の [すべての操作] に対して構成されます。API scope is configured for All Operations of the selected API.

  1. ポリシーを適用する API を選びます。Select the API you want to apply policies to.

    API スコープ

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

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

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

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

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

操作スコープOperation scope

操作スコープは、選択した操作に対して構成されます。Operation scope is configured for the selected operation.

  1. API を選びます。Select an API.

  2. ポリシーを適用する操作を選びます。Select the operation you want to apply policies to.

    操作スコープ

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

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

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

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

次の手順Next steps

次の関連トピックをご覧ください。See the following related topics: