API Management ポリシー リファレンス
このセクションでは、すべての API Management ポリシーのリファレンス記事へのリンクを示します。
ポリシーの詳細:
重要
"呼び出しレートをサブスクリプション別に制限する" と "使用量のクォータをサブスクリプション別に設定する" は、サブスクリプション キーに依存します。 他のポリシーが適用されている場合、サブスクリプション キーは必要ありません。
アクセス制限ポリシー
- HTTP ヘッダーを確認する - HTTP ヘッダーの存在と値の両方、またはそのどちらかを適用します。
- 承認コンテキストの取得 - API Management インスタンスで構成された指定の承認の承認コンテキストを取得します。
- 呼び出しレートをサブスクリプション別に制限する - 呼び出しレートをサブスクリプションに基づいて制限することで、API の使用量の急増を防ぎます。
- 呼び出しレートをキー別に制限する - 呼び出しレートをキーに基づいて制限することで、API の使用量の急増を防ぎます。
- 呼び出し元 IP を制限する - 特定の IP アドレスとアドレス範囲の両方、またはそのどちらかからの呼び出しをフィルター処理 (許可/拒否) します。
- 使用量のクォータをサブスクリプション別に設定する - 更新可能な呼び出しまたは有効期間中の呼び出しのボリュームと帯域幅クォータの両方またはそのどちらかをサブスクリプションに基づいて適用できます。
- 使用量のクォータをキー別に設定する - 更新可能な呼び出しまたは有効期間中の呼び出しのボリュームと帯域幅クォータの両方またはそのどちらかをキーに基づいて適用できます。
- Azure Active Directory トークンを検証する - 指定された HTTP ヘッダー、クエリ パラメーター、またはトークン値から抽出した Azure Active Directory JWT の存在と有効性を適用させます。
- JWT を検証する - 指定された HTTP ヘッダー、クエリ パラメーター、またはトークン値から抽出した JWT の存在と有効性を適用します。
- クライアント証明書の検証 -クライアントから API Management インスタンスに提示された証明書が、指定された検証規則と要求に一致することを強制します。
高度なポリシー
- 制御フロー - ブール式の評価の結果に基づいてポリシー ステートメントを条件付きで適用します。
- メトリックを送信する - 実行時にカスタム メトリックを Application Insights に送信します。
- 要求を転送する - バックエンド サービスに要求を転送します。
- フラグメントを含める - ポリシー定義にポリシー フラグメントを挿入します。
- コンカレンシーを制限する - 含まれているポリシーが指定された数を超える要求によって同時に実行されないようにします。
- イベント ハブにログを記録する - 指定された形式のメッセージを Logger エンティティによって定義されたイベント ハブに送信します。
- Mock response (モック応答) - パイプラインの実行を中止し、モック応答を呼び出し元に直接返します。
- 再試行 - 条件が満たされるまで、囲まれたポリシー ステートメントの実行を再試行します。 実行は、指定された間隔で、指定された最大試行回数まで繰り返されます。
- 応答を返す - パイプラインの実行を中止し、指定された応答を呼び出し元に直接返します。
- 1 方向の要求を送信する - 指定された URL に要求を送信します。応答は待機しません。
- 要求を送信する - 指定された URL に要求を送信します。
- HTTP プロキシを設定する - HTTP プロキシ経由で、転送された要求をルーティングできます。
- 要求メソッドを設定する - 要求の HTTP メソッドを変更できます。
- 状態コードを設定する - HTTP 状態コードを指定された値に変更します。
- 変数の設定 - 名前付きコンテキスト変数の値を、後でアクセスできるように保持します。
- トレース - テスト コンソール、Application Insights テレメトリ、リソース ログの要求トレース出力にカスタム トレースを追加します。
- 待機 - 含まれている要求を送信する、キャッシュからの値の取得、または制御フロー ポリシーが完了するまで待機してから次に進みます。
認証ポリシー
- 基本認証 -基本認証を使用してバックエンド サービスで認証します。
- クライアント証明書による認証 -クライアント証明書を使用してバックエンド サービスで認証します。
- マネージド ID による認証 - マネージド ID を使用してバックエンド サービスで認証します。
キャッシュ ポリシー
- キャッシュから取得 - キャッシュを検索して、キャッシュに格納された有効な応答があればそれを返します。
- キャッシュに格納 - 指定されたキャッシュ制御の構成に従って応答をキャッシュに格納します。
- キャッシュから値を取得 - キャッシュされたキー別の項目を取得します。
- 値をキャッシュに格納 - 項目をキー別にキャッシュに格納します。
- キャッシュから値を削除 - キー別にキャッシュ内の項目を削除します。
クロスドメイン ポリシー
- クロスドメイン呼び出しを許可 - Adobe Flash や Microsoft Silverlight ブラウザーベースのクライアントから API を利用できるようにします。
- CORS - クロス オリジン リソース共有 (CORS) のサポートを操作または API に追加して、ブラウザーベースのクライアントからのクロスドメイン呼び出しを可能にします。
- JSONP - JSON with padding (JSONP) のサポートを操作または API に追加して、JavaScript ブラウザーベースのクライアントからのクロスドメイン呼び出しを可能にします。
Dapr 統合ポリシー
- サービスへの要求の送信:Dapr ランタイムを使用して Dapr マイクロサービスを検索し、このマイクロサービスとの通信を確実に行います。 Dapr でのサービス呼び出しの詳細については、この README ファイルの説明を参照してください。
- Pub/Sub トピックへのメッセージの送信:Dapr ランタイムを使用して、Publish/Subscribe トピックにメッセージを発行します。 Dapr での Publish/Subscribe メッセージングの詳細については、この README ファイルの説明を参照してください。
- トリガー出力バインド:Dapr ランタイムを使用して、出力バインドを介して外部システムを呼び出します。 Dapr でのバインドの詳細については、この README ファイルの説明を参照してください。
GraphQL リゾルバー ポリシー
- リゾルバーのための HTTP データ ソース - GraphQL スキーマ内のオブジェクト タイプとフィールドのデータを解決するために、HTTP 要求を構成し、必要に応じて HTTP 応答を構成します。
- GraphQL サブスクリプションへのイベントの発行 - GraphQL API スキーマで指定された 1 つ以上のサブスクリプションにイベントを発行します。
http-data-sourceポリシーのhttp-response要素で使用されます
変換ポリシー
- JSON から XML への変換 - 要求本文または応答本文を JSON から XML に変換します。
- XML から JSON への変換 - 要求本文または応答本文を XML から JSON に変換します。
- 本文内の文字列の検索および置換 - 要求または応答の部分文字列を検索して、別の部分文字列に置き換えます。
- コンテンツ内の URL のマスク - ゲートウェイを経由して同じリンクをポイントするよう、応答本文のリンクを書き換えます (マスクします)。
- バックエンド サービスの設定 -受信要求のバックエンド サービスを変更します。
- 本文の設定 - 着信要求と発信要求のメッセージ本文を設定します。
- HTTP ヘッダーの設定 - 既存の応答または要求ヘッダーまたは新しい応答または要求ヘッダーに値を割り当てます。
- クエリ文字列パラメーターの設定 - 要求クエリ文字列パラメーターの追加、値の置換、または削除を行います。
- URL の書き換え - 要求 URL をパブリックな形式から Web サービスで想定されている形式に変換します。
- XSLT を使用した XML の変換 - 要求本文または応答本文に含まれる XML に XSL 変換を適用します。
検証ポリシー
- コンテンツを検証する - 1 つ以上の API スキーマに対して、要求または応答の本文のサイズまたはコンテンツを検証します。 サポートされているスキーマ形式は、JSON および XML です。
- GraphQL 要求を検証する - GraphQL API への要求を検証して承認します。
- パラメーターを検証する - API スキーマに対して要求ヘッダー、クエリ、またはパス パラメーターを検証します。
- ヘッダーを検証する - API スキーマに対して応答ヘッダーを検証します。
- 状態コードを検証する - API スキーマに対して応答の HTTP 状態コードを検証します。
次のステップ
ポリシーに対する処理の詳細については、次のトピックを参照してください。