API Management ポリシー リファレンス

  • [アーティクル]

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

このセクションでは、すべての API Management ポリシーのリファレンス記事の簡単な説明とリンクを示します。 各ポリシーをサポートする API Management ゲートウェイ が示されます。 詳細なポリシー設定と例については、リンクされたリファレンス記事を参照してください。

ポリシーの詳細:

重要

"呼び出しレートをサブスクリプション別に制限する" と "使用量のクォータをサブスクリプション別に設定する" は、サブスクリプション キーに依存します。 他のポリシーが適用されている場合、サブスクリプション キーは必要ありません。

レート制限とクォータ

ポリシー 説明 クラシック V2 従量課金 セルフホステッド
呼び出しレートをサブスクリプション別に制限する サブスクリプションごとに、呼び出し頻度を制限することで API 使用量の急増を防ぎます。 はい イエス イエス はい
呼び出しレートをキー別に制限する 呼び出しレートをキーに基づいて制限することで、API の使用量の急増を防ぎます。 はい はい いいえ はい
使用量のクォータをサブスクリプション別に設定する 更新可能な呼び出しまたは有効期間中の呼び出しのボリュームと帯域幅クォータの両方またはそのどちらかをサブスクリプションに基づいて適用できます。 はい イエス イエス はい
使用量のクォータをキー別に設定する 更新可能な呼び出しまたは有効期間中の呼び出しのボリュームと帯域幅クォータの両方またはそのどちらかをキーに基づいて適用できます。 はい いいえ 番号 はい
コンカレンシーを制限する 含まれているポリシーが指定された数を超える要求によって同時に実行されないようにします。 はい イエス イエス はい

認証と認可

ポリシー 説明 クラシック V2 従量課金 セルフホステッド
HTTP ヘッダーを確認する HTTP ヘッダーの存在または値を適用します。 はい イエス イエス はい
認可コンテキストを取得する API Management インスタンスで構成された資格情報プロバイダーへの指定された接続の認可コンテキストを取得します。 はい イエス はい いいえ
呼び出し元 IP を制限する 特定の IP アドレスまたはアドレス範囲からの呼び出しをフィルター処理 (許可、拒否) します。 はい イエス イエス はい
Microsoft Entra トークンを検証する 指定された HTTP ヘッダー、クエリ パラメーター、またはトークン値から抽出した Microsoft Entra (旧称 Azure Active Directory) JWT の存在と有効性を適用させます。 はい イエス イエス はい
JWT を検証する 指定された HTTP ヘッダー、クエリ パラメーター、またはトークン値から抽出した JWT の存在と有効性を適用させます。 はい イエス イエス はい
クライアント証明書を検証する クライアントから API Management インスタンスに提示された証明書が、指定された検証規則と要求に一致することを強制します。 はい イエス イエス はい
基本認証 基本認証を使用してバックエンド サービスで認証します。 はい イエス イエス はい
クライアント証明書による認証 クライアント認証を使用してバックエンド サービスで認証します。 はい イエス イエス はい
マネージド ID で認証を行う マネージド ID を使用してバックエンド サービスで認証します。 はい イエス イエス はい

コンテンツの検証

ポリシー 説明 クラシック V2 従量課金 セルフホステッド
コンテンツの検証 1 つ以上の API スキーマに対して、要求または応答の本文のサイズまたはコンテンツを検証します。 サポートされているスキーマ形式は、JSON および XML です。 はい イエス イエス はい
GraphQL 要求の検証 GraphQL API への要求を検証して承認します。 はい イエス イエス はい
OData 要求を検証する OData API への要求を検証して、OData 仕様に準拠していることを確認します。 はい イエス イエス はい
パラメーターを検証する API スキーマに対して、要求ヘッダー、クエリ、またはパス パラメーターを検証します。 はい イエス イエス はい
ヘッダーを検証する API スキーマに対して応答ヘッダーを検証します。 はい イエス イエス はい
状態コードを検証する API スキーマに対して応答の HTTP 状態コードを検証します。 はい イエス イエス はい

ルーティング

ポリシー 説明 クラシック V2 従量課金 セルフホステッド
要求を転送する バックエンド サービスに要求を転送します。 はい イエス イエス はい
バックエンド サービスを設定する 受信要求のバックエンド サービス ベース URL を URL またはバックエンドに変更します。 バックエンド リソースを参照すると、バックエンド サービスのベース URL やその他の設定を 1 か所で管理できます。 また、バックエンド サービスのプール全体のトラフィックの負荷分散とサーキット ブレーカールールを実装して、バックエンドを多くの要求から保護します。 はい イエス イエス はい
HTTP プロキシを設定する HTTP プロキシ経由で、転送された要求をルーティングできます。 はい イエス イエス はい

キャッシュ

ポリシー 説明 クラシック V2 従量課金 セルフホステッド
キャッシュから取得 キャッシュを参照し、使用可能な場合は有効なキャッシュ済み応答を返します。 はい イエス イエス はい
キャッシュに格納 指定したキャッシュ制御構成に従って応答をキャッシュします。 はい イエス イエス はい
キャッシュから値を取得する キーでキャッシュされた項目を取得します。 はい イエス イエス はい
値をキャッシュに格納する 項目をキーでキャッシュに格納します。 はい イエス イエス はい
キャッシュから値を削除する キーによってキャッシュ内の項目を削除します。 はい イエス イエス はい

変換

ポリシー 説明 クラシック V2 従量課金 セルフホステッド
要求メソッドを設定する 要求の HTTP メソッドを変更できます。 はい イエス イエス はい
状態コードを設定する HTTP 状態コードを指定された値に変更します。 はい イエス イエス はい
変数の設定 後からアクセスするため、指定したコンテキスト変数の値を保持します。 はい イエス イエス はい
本文を設定する 要求または応答のメッセージ本文を設定します。 はい イエス イエス はい
HTTP ヘッダーを設定する 既存の応答ヘッダーまたは要求ヘッダーに値を割り当てるか、新しい応答ヘッダーまたは要求ヘッダーを追加します。 はい イエス イエス はい
クエリ文字列のパラメーターを設定する 要求のクエリ文字列パラメーターを追加、値の置換または削除します。 はい イエス イエス はい
URL を書き換える 要求の URL をパブリック形式から Web サービスで想定されている形式に変換します。 はい イエス イエス はい
JSON から XML に変換する 要求または応答本文を JSON から XML に変換します。 はい イエス イエス はい
XML から JSON に変換する 要求または応答本文を XML から JSON に変換します。 はい イエス イエス はい
本文内の文字列を検索して置換する 要求または応答内の文字部分列を検索し、別の部分文字列に置き換えます。 はい イエス イエス はい
コンテンツ内の URL をマスクする 応答本文内のリンクを、ゲートウェイを経由して同じリンクをポイントするように書き換えます (マスクします)。 はい イエス イエス はい
XSLT を使って XML を変換する 要求本文または応答本文に含まれる XML に XSL 変換を適用します。 はい イエス イエス はい
応答の返信 パイプラインの実行を中止し、指定された応答を呼び出し元に直接返します。 はい イエス イエス はい
Mock response (モック応答) パイプラインの実行を中止し、モック応答を呼び出し元に直接返します。 はい イエス イエス はい

クロスドメイン

ポリシー 説明 クラシック V2 従量課金 セルフホステッド
クロスドメイン呼び出しを許可 Adobe Flash と Microsoft Silverlight のブラウザーベースのクライアントから、API にアクセスできるようにします。 はい イエス イエス はい
CORS Cross-Origin Resource Sharing (CORS) のサポートを操作または API に追加して、ブラウザーベースのクライアントからドメイン間の呼び出しを可能にします。 はい イエス イエス はい
JSONP JSON with Padding (JSONP) のサポートを操作または API に追加して、JavaScript ブラウザーベースのクライアントからドメイン間の呼び出しを可能にします。 はい イエス イエス はい

統合と外部通信

ポリシー 説明 クラシック V2 従量課金 セルフホステッド
要求を送信する 要求を指定した URL に送信します。 はい イエス イエス はい
1 方向の要求を送信する 指定された URL に要求を送信します。応答は待機しません。 はい イエス イエス はい
イベント ハブにログを記録する 指定された形式のメッセージを Logger エンティティによって定義されたイベント ハブに送信します。 はい イエス イエス はい
サービスに要求を送信する (Dapr) Dapr ランタイムを使用して Dapr マイクロサービスを検索し、このマイクロサービスとの通信を確実に行います。 Dapr でのサービス呼び出しの詳細については、この README ファイルの説明を参照してください。 いいえ 番号 番号 はい
Pub/Sub トピックにメッセージを送信する (Dapr) Dapr ランタイムを使用して、Publish/Subscribe トピックにメッセージを発行します。 Dapr での Publish/Subscribe メッセージングの詳細については、この README ファイルの説明を参照してください。 いいえ 番号 番号 はい
出力バインドをトリガーする (Dapr) Dapr ランタイムを使用して、出力バインドを介して外部システムを呼び出します。 Dapr でのバインドの詳細については、この README ファイルの説明を参照してください。 いいえ 番号 番号 はい

ログ機能

ポリシー 説明 クラシック V2 従量課金 セルフホステッド
トレース テスト コンソール、Application Insights テレメトリ、リソース ログの要求トレース出力にカスタム トレースを追加します。 はい 可1 はい はい
メトリックを送信する 実行時にカスタム メトリックを Application Insights に送信します。 はい イエス イエス はい

1 V2 ゲートウェイでは、現在、trace ポリシーはテスト コンソールにトレース出力を追加しません。

GraphQL リゾルバー

ポリシー 説明 クラシック V2 従量課金 セルフホステッド
リゾルバーの Azure SQL データ ソース GraphQL スキーマ内のオブジェクト型とフィールドのデータを解決するために、Azure SQL 要求と省略可能な応答を構成します。 はい はい いいえ いいえ
リゾルバーの Cosmos DB データ ソース GraphQL スキーマ内のオブジェクト型とフィールドのデータを解決するために、Cosmos DB 要求と省略可能な応答を構成します。 はい はい いいえ いいえ
リゾルバーの HTTP データ ソース GraphQL スキーマ内のオブジェクト タイプとフィールドのデータを解決するために HTTP 要求を構成し、必要に応じて HTTP 応答を構成します。 はい イエス はい いいえ
GraphQL サブスクリプションにイベントを発行する GraphQL API スキーマで指定された 1 つ以上のサブスクリプションにイベントを発行します。 ミューテーションなど、別の操作タイプのスキーマ内の関連フィールド用 GraphQL リゾルバー内にポリシーを構成します。 はい イエス はい いいえ

ポリシーの制御とフロー

ポリシー 説明 クラシック V2 従量課金 セルフホステッド
制御フロー ブール式の評価結果に基づいて、ポリシー ステートメントが条件付きで適用されます。 はい イエス イエス はい
フラグメントを含める ポリシー定義にポリシー フラグメントを挿入します。 はい イエス イエス はい
再試行 条件が満たされるまで、囲まれたポリシー ステートメントの実行を再試行します。 実行は、指定された間隔で、指定された最大試行回数まで繰り返されます。 はい イエス イエス はい
待機 含まれている要求を送信する、キャッシュからの値の取得、または制御フロー ポリシーが完了するまで待機してから次に進みます。 はい イエス イエス はい

関連するコンテンツ

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