OData 要求を検証する
適用対象: すべての API Management レベル
validate-odata-request ポリシーでは、OData API への要求の要求 URL、ヘッダー、パラメーターを検証して、OData 仕様に準拠していることを確認します。
Note
現在、このポリシーはプレビュー段階です。
ポリシー ステートメント
<validate-odata-request error-variable-name="variable name" default-odata-version="OData version number" min-odata-version="OData version number" max-odata-version="OData version number" max-size="size in bytes" />
属性
| 属性 | 説明 | 必要 | Default |
|---|---|---|---|
| error-variable-name | 検証エラーをログに記録する context.Variables の変数の名前。 |
いいえ | 該当なし |
| default-odata-version | 要求に OData-Version ヘッダーが含まれていない場合に、パラメーターの検証が想定される既定の OData バージョン。 |
いいえ | 4.0 |
| min-odata-version | ポリシーが受け入れる要求の OData-Version ヘッダー内の最小 OData バージョン。 |
いいえ | 該当なし |
| max-odata-version | ポリシーが受け入れる要求の OData-Version ヘッダー内の最大 OData バージョン。 |
いいえ | なし |
| max-size | 要求ペイロードの最大サイズ (バイト単位)。 | いいえ | 該当なし |
使用法
- ポリシー セクション: inbound
- ポリシー スコープ: グローバル、ワークスペース、製品、API
- ゲートウェイ: クラシック、v2、従量課金、セルフホステッド
使用上の注意
- API Management にインポートされた OData API のポリシーを構成します。
- このポリシーは、ポリシー セクションで一度だけ使用できます。
例
次の例では、OData API への要求を検証し、OData-Version ヘッダーが存在しない場合は既定の OData バージョン (4.01) を想定しています。
<validate-odata-request default-odata-version="4.01" />
関連ポリシー
関連するコンテンツ
ポリシーに対する処理の詳細については、次のトピックを参照してください。
- チュートリアル:API を変換および保護する
- ポリシー ステートメントとその設定の一覧に関するポリシー リファレンス
- ポリシー式
- ポリシーの設定または編集
- ポリシー構成を再利用する
- ポリシー スニペットのリポジトリ
- Microsoft Copilot for Azure を使用してポリシーを作成する