ApiBehaviorOptions.SuppressMapClientErrors プロパティ

定義

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

コントローラーが特定のクライアントエラーを変換するかどうかを決定する値を ApiControllerAttribute 取得または設定します。

の場合 false、を変換 IClientErrorActionResultする API コントローラーアクションに結果フィルターが追加されます。それ以外の場合、フィルターは抑制されます。

既定では、 ClientErrorMapping はインスタンスにProblemDetailsマップIClientErrorActionResultするために使用されます (の値ObjectResultとして返されます)。

フィルターの出力をカスタマイズするには (たとえば、別のエラーの種類を返す場合)、のカスタム実装 IClientErrorFactory をサービスコレクションに登録します。

public:
 property bool SuppressMapClientErrors { bool get(); void set(bool value); };

public bool SuppressMapClientErrors { get; set; }

member this.SuppressMapClientErrors : bool with get, set

Public Property SuppressMapClientErrors As Boolean

Boolean

既定値は false です。

このプロパティは互換性スイッチに関連付けられているので、アプリケーションの構成済みの互換性バージョンに応じて異なる動作を提供できます。アプリケーションの互換性バージョンの設定のガイダンスと例については、「」を参照してください CompatibilityVersion 。

このプロパティのセッターを呼び出して互換性スイッチの目的の値を構成すると、アプリケーション CompatibilityVersionのによって暗黙的に指定された値よりも優先されます。

アプリケーションの互換性バージョンが以下に設定されている場合は、明示的に Version_2_1 構成しない限り、この設定の値 false が設定されます。

アプリケーションの互換性バージョンが以上に設定されている場合、明示的に Version_2_2 構成しない限り、この設定の値 true が設定されます。