IApplicationBuilder インターフェイス

定義

名前空間:

Microsoft.AspNetCore.Builder

アセンブリ:

Microsoft.AspNetCore.Http.Abstractions.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v7.0.5

アプリケーションの要求パイプラインを構成するメカニズムを提供するクラスを定義します。

public interface class IApplicationBuilder

public interface IApplicationBuilder

type IApplicationBuilder = interface

Public Interface IApplicationBuilder

派生

Microsoft.AspNetCore.Builder.ApplicationBuilder

Microsoft.AspNetCore.Builder.WebApplication

Microsoft.AspNetCore.MiddlewareAnalysis.AnalysisBuilder

プロパティ

ApplicationServices	アプリケーションの IServiceProvider サービス コンテナーへのアクセスを提供する を取得または設定します。
Properties	ミドルウェア間でデータを共有するために使用できるキー/値コレクションを取得します。
ServerFeatures	アプリケーションのサーバーが提供する HTTP 機能のセットを取得します。

メソッド

Build()	このアプリケーションが HTTP 要求を処理するために使用するデリゲートをビルドします。
New()	この IApplicationBuilderの を共有する新しい IApplicationBuilder をProperties作成します。
Use(Func<RequestDelegate,RequestDelegate>)	アプリケーションの要求パイプラインにミドルウェア デリゲートを追加します。

拡張メソッド

UseRequestLocalization(IApplicationBuilder)	RequestLocalizationMiddlewareを追加して、クライアントから提供された情報に基づいて要求のカルチャ情報を自動的に設定します。
UseRequestLocalization(IApplicationBuilder, RequestLocalizationOptions)	RequestLocalizationMiddlewareを追加して、クライアントから提供された情報に基づいて要求のカルチャ情報を自動的に設定します。
UseRequestLocalization(IApplicationBuilder, Action<RequestLocalizationOptions>)	RequestLocalizationMiddlewareを追加して、クライアントから提供された情報に基づいて要求のカルチャ情報を自動的に設定します。
UseRequestLocalization(IApplicationBuilder, String[])	RequestLocalizationMiddlewareを追加して、クライアントから提供された情報に基づいて要求のカルチャ情報を自動的に設定します。
UseAuthentication(IApplicationBuilder)	AuthenticationMiddleware指定した IApplicationBuilderに を追加します。これにより、認証機能が有効になります。
UseAuthorization(IApplicationBuilder)	AuthorizationMiddleware指定した IApplicationBuilderに を追加します。これにより、承認機能が有効になります。 エンドポイント ルーティングを使用してルーティングされるリソースを承認する場合、ミドルウェアが正しく機能するには、 と app.UseEndpoints(...) のapp.UseRouting()呼び出しの間にこの呼び出しが表示される必要があります。
UseCertificateForwarding(IApplicationBuilder)	要求ヘッダーで証明書を検索するミドルウェアをパイプラインに追加してデコードし、HttpContext.Connection.ClientCertificate を更新します。
UseBlazorFrameworkFiles(IApplicationBuilder)	ルート パス "/" から Blazor WebAssembly フレームワーク ファイルを提供するようにアプリケーションを構成します。
UseBlazorFrameworkFiles(IApplicationBuilder, PathString)	パス pathPrefixから Blazor WebAssembly フレームワーク ファイルを提供するようにアプリケーションを構成します。 このパスは、参照されている Blazor WebAssembly アプリケーション プロジェクトに対応している必要があります。
UseConcurrencyLimiter(IApplicationBuilder)	ConcurrencyLimiterMiddlewareを追加して、同時に実行される要求の数を制限します。
UseCookiePolicy(IApplicationBuilder)	指定した CookiePolicyMiddlewareIApplicationBuilderにハンドラーを追加します。これにより、Cookie ポリシー機能が有効になります。
UseCookiePolicy(IApplicationBuilder, CookiePolicyOptions)	指定した CookiePolicyMiddlewareIApplicationBuilderにハンドラーを追加します。これにより、Cookie ポリシー機能が有効になります。
UseCors(IApplicationBuilder)	クロスドメイン要求を許可するために、CORS ミドルウェアを Web アプリケーション パイプラインに追加します。
UseCors(IApplicationBuilder, Action<CorsPolicyBuilder>)	クロスドメイン要求を許可するために、CORS ミドルウェアを Web アプリケーション パイプラインに追加します。
UseCors(IApplicationBuilder, String)	クロスドメイン要求を許可するために、CORS ミドルウェアを Web アプリケーション パイプラインに追加します。
UseDatabaseErrorPage(IApplicationBuilder)	互換性のために残されています。 Entity Framework の移行を使用して解決できるパイプラインから、同期および非同期のデータベース関連の例外をキャプチャします。 これらの例外が発生すると、問題が解決する可能性のあるアクションの詳細を含む HTML 応答が生成されます。
UseDatabaseErrorPage(IApplicationBuilder, DatabaseErrorPageOptions)	互換性のために残されています。 Entity Framework の移行を使用して解決できるパイプラインから、同期および非同期のデータベース関連の例外をキャプチャします。 これらの例外が発生すると、問題が解決する可能性のあるアクションの詳細を含む HTML 応答が生成されます。
UseDefaultFiles(IApplicationBuilder)	現在のパスで既定のファイル マッピングを有効にします
UseDefaultFiles(IApplicationBuilder, DefaultFilesOptions)	指定されたオプションで既定のファイル マッピングを有効にします
UseDefaultFiles(IApplicationBuilder, String)	指定された要求パスの既定のファイル マッピングを有効にします
UseDeveloperExceptionPage(IApplicationBuilder)	パイプラインから同期インスタンスと非同期 Exception インスタンスをキャプチャし、HTML エラー応答を生成します。
UseDeveloperExceptionPage(IApplicationBuilder, DeveloperExceptionPageOptions)	パイプラインから同期インスタンスと非同期 Exception インスタンスをキャプチャし、HTML エラー応答を生成します。
UseDirectoryBrowser(IApplicationBuilder)	現在のパスでディレクトリ参照を有効にする
UseDirectoryBrowser(IApplicationBuilder, DirectoryBrowserOptions)	指定されたオプションでディレクトリの参照を有効にします
UseDirectoryBrowser(IApplicationBuilder, String)	指定された要求パスのディレクトリ参照を有効にします
UseEndpoints(IApplicationBuilder, Action<IEndpointRouteBuilder>)	構成された Microsoft.AspNetCore.Routing.EndpointMiddlewareIEndpointRouteBuilderから構築されたインスタンスを使用して、EndpointDataSource指定された IApplicationBuilder にミドルウェアを追加します。 は Microsoft.AspNetCore.Routing.EndpointMiddleware 、現在の要求に Endpoint 関連付けられている を実行します。
UseRouting(IApplicationBuilder)	指定した Microsoft.AspNetCore.Routing.EndpointRoutingMiddleware にミドルウェアを追加します IApplicationBuilder。
UseExceptionHandler(IApplicationBuilder)	例外をキャッチし、それらをログに記録し、代替パイプラインで要求を再実行するミドルウェアをパイプラインに追加します。 応答が既に開始されている場合、要求は再実行されません。
UseExceptionHandler(IApplicationBuilder, ExceptionHandlerOptions)	例外をキャッチし、それらをログに記録し、代替パイプラインで要求を再実行するミドルウェアをパイプラインに追加します。 応答が既に開始されている場合、要求は再実行されません。
UseExceptionHandler(IApplicationBuilder, Action<IApplicationBuilder>)	例外をキャッチし、それらをログに記録し、代替パイプラインで要求を再実行するミドルウェアをパイプラインに追加します。 応答が既に開始されている場合、要求は再実行されません。
UseExceptionHandler(IApplicationBuilder, String)	例外をキャッチし、それらをログに記録し、要求パスをリセットし、要求を再実行するミドルウェアをパイプラインに追加します。 応答が既に開始されている場合、要求は再実行されません。
UseFileServer(IApplicationBuilder)	現在のディレクトリの現在の要求パスについて、すべての静的ファイル ミドルウェア (ディレクトリの参照を除く) を有効にします。
UseFileServer(IApplicationBuilder, FileServerOptions)	すべての静的ファイル ミドルウェアを、指定されたオプションで有効にします。
UseFileServer(IApplicationBuilder, Boolean)	現在のディレクトリの現在の要求パスについて、すべての静的ファイル ミドルウェアを有効にします。
UseFileServer(IApplicationBuilder, String)	同じ名前のディレクトリからの指定された要求パスについて、すべての静的ファイル ミドルウェア (ディレクトリの参照を除く) を有効にします。
UseForwardedHeaders(IApplicationBuilder)	現在の要求の一致するフィールドに転送されたヘッダーを適用します。 慣例により、HTTP プロキシは既知の HTTP ヘッダーでクライアントから情報を転送します。 は ForwardedHeadersMiddleware 、これらのヘッダーを読み取り、HttpContext の関連フィールドに入力します。
UseForwardedHeaders(IApplicationBuilder, ForwardedHeadersOptions)	現在の要求の一致するフィールドに転送されたヘッダーを適用します。 慣例により、HTTP プロキシは既知の HTTP ヘッダーでクライアントから情報を転送します。 は ForwardedHeadersMiddleware 、これらのヘッダーを読み取り、HttpContext の関連フィールドに入力します。
UseHeaderPropagation(IApplicationBuilder)	に伝達されるヘッダーを収集するミドルウェアを HttpClient追加します。
UseHealthChecks(IApplicationBuilder, PathString)	正常性チェック状態を提供するミドルウェアを追加します。
UseHealthChecks(IApplicationBuilder, PathString, HealthCheckOptions)	正常性チェック状態を提供するミドルウェアを追加します。
UseHealthChecks(IApplicationBuilder, PathString, Int32)	正常性チェック状態を提供するミドルウェアを追加します。
UseHealthChecks(IApplicationBuilder, PathString, Int32, HealthCheckOptions)	正常性チェック状態を提供するミドルウェアを追加します。
UseHealthChecks(IApplicationBuilder, PathString, String)	正常性チェック状態を提供するミドルウェアを追加します。
UseHealthChecks(IApplicationBuilder, PathString, String, HealthCheckOptions)	正常性チェック状態を提供するミドルウェアを追加します。
UseHostFiltering(IApplicationBuilder)	許可されたホスト ヘッダーで要求をフィルター処理するためのミドルウェアを追加します。 無効な要求は、400 状態コードで拒否されます。
UseHsts(IApplicationBuilder)	HSTS を使用するためのミドルウェアを追加します。これにより、Strict-Transport-Security ヘッダーが追加されます。
UseHttpLogging(IApplicationBuilder)	HTTP 要求と応答をログに記録できるミドルウェアを追加します。
UseW3CLogging(IApplicationBuilder)	サーバー ログの HTTP 要求と応答を W3C 形式でログに記録できるミドルウェアを追加します。
UseHttpMethodOverride(IApplicationBuilder)	受信 POST 要求で、ヘッダーで指定された型を使用してメソッドの型をオーバーライドできるようにします。 このミドルウェアは、クライアントが GET メソッドまたは POST メソッドの送信に制限されているが、他の HTTP メソッドを呼び出す場合に使用されます。 既定では、X-HTTP-Method-Override 要求ヘッダーを使用して、トンネリングする HTTP メソッドを指定します。
UseHttpMethodOverride(IApplicationBuilder, HttpMethodOverrideOptions)	受信 POST 要求で、フォームで指定された型を使用してメソッドの型をオーバーライドできるようにします。 このミドルウェアは、クライアントが GET メソッドまたは POST メソッドの送信に制限されているが、他の HTTP メソッドを呼び出す場合に使用されます。
UseHttpsRedirection(IApplicationBuilder)	HTTP 要求を HTTPS にリダイレクトするためのミドルウェアを追加します。
Map(IApplicationBuilder, PathString, Action<IApplicationBuilder>)	指定された要求パスの一致に基づいて要求パイプラインを分岐します。 要求パスが指定されたパスで開始する場合、分岐が実行されます。
Map(IApplicationBuilder, PathString, Boolean, Action<IApplicationBuilder>)	指定された要求パスの一致に基づいて要求パイプラインを分岐します。 要求パスが指定されたパスで開始する場合、分岐が実行されます。
Map(IApplicationBuilder, String, Action<IApplicationBuilder>)	指定された要求パスの一致に基づいて要求パイプラインを分岐します。 要求パスが指定されたパスで開始する場合、分岐が実行されます。
MapWhen(IApplicationBuilder, Func<HttpContext,Boolean>, Action<IApplicationBuilder>)	指定された述語の結果に基づいて、要求パイプラインを分岐します。
UseMigrationsEndPoint(IApplicationBuilder)	移行操作の実行要求を処理します。 ミドルウェアは に対して行われた要求をリッスンします DefaultPath。
UseMigrationsEndPoint(IApplicationBuilder, MigrationsEndPointOptions)	移行操作の実行要求を処理します。 ミドルウェアは、 で options構成されたパスへの要求をリッスンします。
UseMvc(IApplicationBuilder)	MVC を要求実行パイプラインに IApplicationBuilder 追加します。
UseMvc(IApplicationBuilder, Action<IRouteBuilder>)	MVC を要求実行パイプラインに IApplicationBuilder 追加します。
UseMvcWithDefaultRoute(IApplicationBuilder)	"default" という名前の IApplicationBuilder 既定のルートと、'{controller=Home}/{action=Index}/{id?}' という名前の既定のルートを使用して、MVC を要求実行パイプラインに追加します。
UseOutputCache(IApplicationBuilder)	アプリケーションの要求パイプラインを構成するメカニズムを提供するクラスを定義します。
UseOwin(IApplicationBuilder)	指定した に OWIN パイプラインを追加します IApplicationBuilder。
UseOwin(IApplicationBuilder, Action<Action<Func<Func<IDictionary<String,Object>,Task>,Func<IDictionary<String,Object>,Task>>>>)	指定した に OWIN ミドルウェア パイプラインを追加します IApplicationBuilder。
UseRateLimiter(IApplicationBuilder)	アプリケーションのレート制限を有効にします。
UseRateLimiter(IApplicationBuilder, RateLimiterOptions)	アプリケーションのレート制限を有効にします。
UseRequestDecompression(IApplicationBuilder)	HTTP 要求本文を動的に圧縮解除するためのミドルウェアを追加します。
UseResponseCaching(IApplicationBuilder)	HTTP 応答を ResponseCachingMiddleware キャッシュするための を追加します。
UseResponseCompression(IApplicationBuilder)	HTTP 応答を動的に圧縮するためのミドルウェアを追加します。
UseRewriter(IApplicationBuilder)	指定された URL がルールと条件に一致するかどうかを確認し、一致時に HttpContext を変更します。
UseRewriter(IApplicationBuilder, RewriteOptions)	指定された URL がルールと条件に一致するかどうかを確認し、一致時に HttpContext を変更します。
UseRouter(IApplicationBuilder, IRouter)	指定した を使用 RouterMiddleware して、指定した IApplicationBuilder にミドルウェアを追加します IRouter。
UseRouter(IApplicationBuilder, Action<IRouteBuilder>)	構成された RouterMiddlewareIRouteBuilderからビルドされた を使用して、指定された にミドルウェアをIRouter追加しますIApplicationBuilder。
Run(IApplicationBuilder, RequestDelegate)	アプリケーションの要求パイプラインにターミナル ミドルウェア デリゲートを追加します。
UseSession(IApplicationBuilder)	SessionMiddlewareを追加して、アプリケーションのセッション状態を自動的に有効にします。
UseSession(IApplicationBuilder, SessionOptions)	SessionMiddlewareを追加して、アプリケーションのセッション状態を自動的に有効にします。
UseSpa(IApplicationBuilder, Action<ISpaBuilder>)	シングル ページ アプリケーション (SPA) の既定のページを返すことによって、ミドルウェア チェーン内のこの時点からのすべての要求を処理します。 このミドルウェアは、静的ファイルや MVC アクションなどを提供するための他のミドルウェアが優先されるように、チェーンの後半に配置する必要があります。
UseStaticFiles(IApplicationBuilder)	現在の要求パスに対する静的ファイル の提供を有効にします
UseStaticFiles(IApplicationBuilder, StaticFileOptions)	指定されたオプションで静的ファイルの提供を有効にします
UseStaticFiles(IApplicationBuilder, String)	指定された要求パスに対する静的ファイル の提供を有効にします
UseStatusCodePages(IApplicationBuilder)	既定の応答ハンドラーを持つ StatusCodePages ミドルウェアを追加します。このミドルウェアでは、本文がない状態コードが 400 ~ 599 の応答をチェックします。
UseStatusCodePages(IApplicationBuilder, StatusCodePagesOptions)	指定されたオプションを持つ StatusCodePages ミドルウェアを追加します。このミドルウェアでは、本文がない状態コードが 400 ~ 599 の応答をチェックします。
UseStatusCodePages(IApplicationBuilder, Action<IApplicationBuilder>)	応答本文を生成するために実行する代替ミドルウェア パイプラインを指定して、StatusCodePages ミドルウェアをパイプラインに追加します。
UseStatusCodePages(IApplicationBuilder, Func<StatusCodeContext,Task>)	指定したハンドラーを使用して StatusCodePages ミドルウェアを追加します。このミドルウェアは、本文がない状態コードが 400 ~ 599 の応答をチェックします。
UseStatusCodePages(IApplicationBuilder, String, String)	送信する応答本文を指定して StatusCodePages ミドルウェアを追加します。 これには、状態コードの '{0}' プレースホルダーが含まれる場合があります。 ミドルウェアは、本文がない状態コードが 400 ~ 599 の応答をチェックします。
UseStatusCodePagesWithRedirects(IApplicationBuilder, String)	StatusCodePages ミドルウェアをパイプラインに追加します。 指定した場所の URL テンプレートを使用してリダイレクトすることで応答を処理する必要があることを指定します。 これには、状態コードの '{0}' プレースホルダーが含まれる場合があります。 '~' で始まる URL には PathBase が付加され、他の URL はそのまま使用されます。
UseStatusCodePagesWithReExecute(IApplicationBuilder, String, String)	StatusCodePages ミドルウェアをパイプラインに追加します。 代替パスを使用して要求パイプラインを再実行することで、応答本文を生成する必要があることを指定します。 このパスには、状態コードの '{0}' プレースホルダーを含めることができます。
Use(IApplicationBuilder, Func<HttpContext,RequestDelegate,Task>)	インラインで定義されたミドルウェア デリゲートをアプリケーションの要求パイプラインに追加します。 次の関数を呼び出していない場合は、代わりに を使用 Run(IApplicationBuilder, RequestDelegate) します。
Use(IApplicationBuilder, Func<HttpContext,Func<Task>,Task>)	インラインで定義されたミドルウェア デリゲートをアプリケーションの要求パイプラインに追加します。 次の関数を呼び出していない場合は、代わりに を使用 Run(IApplicationBuilder, RequestDelegate) します。 次に示すように、パフォーマンスを向上させるために を使用 Use(IApplicationBuilder, Func<HttpContext,RequestDelegate,Task>) することをお勧めします。 app.Use((context, next) => { return next(context); });
UseMiddleware(IApplicationBuilder, Type, Object[])	ミドルウェアの種類をアプリケーションの要求パイプラインに追加します。
UseMiddleware<TMiddleware>(IApplicationBuilder, Object[])	ミドルウェアの種類をアプリケーションの要求パイプラインに追加します。
UsePathBase(IApplicationBuilder, PathString)	要求パスから指定したパス ベースを抽出し、それを要求パス ベースにポストペンするミドルウェアを追加します。
UseWhen(IApplicationBuilder, Func<HttpContext,Boolean>, Action<IApplicationBuilder>)	メイン パイプラインに再参加するブランチを要求パイプラインに条件付きで作成します。
UseWebAssemblyDebugging(IApplicationBuilder)	開発ツール内で Blazor WebAssembly アプリケーションをデバッグするために必要なミドルウェアChromium追加します。
UseWebSockets(IApplicationBuilder)	を WebSocketMiddleware 要求パイプラインに追加します。
UseWebSockets(IApplicationBuilder, WebSocketOptions)	を WebSocketMiddleware 要求パイプラインに追加します。
UseWelcomePage(IApplicationBuilder)	WelcomePageMiddleware をパイプラインに追加します。
UseWelcomePage(IApplicationBuilder, WelcomePageOptions)	指定されたオプションで WelcomePageMiddleware をパイプラインに追加します。
UseWelcomePage(IApplicationBuilder, PathString)	WelcomePageMiddleware を指定されたパスを持つパイプラインに追加します。
UseWelcomePage(IApplicationBuilder, String)	WelcomePageMiddleware を指定されたパスを持つパイプラインに追加します。
UseSpaStaticFiles(IApplicationBuilder)	シングル ページ アプリケーション (SPA) の静的ファイルを提供するようにアプリケーションを構成します。 ファイルは、登録済みサービスを使用して配置されます ISpaStaticFileProvider 。
UseSpaStaticFiles(IApplicationBuilder, StaticFileOptions)	シングル ページ アプリケーション (SPA) の静的ファイルを提供するようにアプリケーションを構成します。 ファイルは、登録済みサービスを使用して配置されます ISpaStaticFileProvider 。