ApplicationBuilder クラス

定義

IApplicationBuilderの既定の実装。

public ref class ApplicationBuilder : Microsoft::AspNetCore::Builder::IApplicationBuilder
public class ApplicationBuilder : Microsoft.AspNetCore.Builder.IApplicationBuilder
type ApplicationBuilder = class
    interface IApplicationBuilder
Public Class ApplicationBuilder
Implements IApplicationBuilder
継承
ApplicationBuilder
実装

コンストラクター

ApplicationBuilder(IServiceProvider)

ApplicationBuilderの新しいインスタンスを初期化します。

ApplicationBuilder(IServiceProvider, Object)

ApplicationBuilderの新しいインスタンスを初期化します。

プロパティ

ApplicationServices

アプリケーション サービスの IServiceProvider を取得します。

Properties

ApplicationBuilderのプロパティのセットを取得します。

ServerFeatures

サーバー機能の IFeatureCollection を取得します。

メソッド

Build()

追加されたミドルウェアを実行する RequestDelegate を生成します。

New()

このアプリケーション ビルダーのコピーを作成します。

作成された複製には、現在のインスタンスと同じプロパティがありますが、要求パイプラインはコピーされません。

Use(Func<RequestDelegate,RequestDelegate>)

ミドルウェアをアプリケーション要求パイプラインに追加します。

拡張メソッド

UseAntiforgery(IApplicationBuilder)

パイプラインに偽造防止ミドルウェアを追加します。

UseRequestLocalization(IApplicationBuilder)

クライアントから提供された情報に基づいて要求のカルチャ情報を自動的に設定する RequestLocalizationMiddleware を追加します。

UseRequestLocalization(IApplicationBuilder, RequestLocalizationOptions)

クライアントから提供された情報に基づいて要求のカルチャ情報を自動的に設定する RequestLocalizationMiddleware を追加します。

UseRequestLocalization(IApplicationBuilder, Action<RequestLocalizationOptions>)

クライアントから提供された情報に基づいて要求のカルチャ情報を自動的に設定する RequestLocalizationMiddleware を追加します。

UseRequestLocalization(IApplicationBuilder, String[])

クライアントから提供された情報に基づいて要求のカルチャ情報を自動的に設定する RequestLocalizationMiddleware を追加します。

UseAuthentication(IApplicationBuilder)

指定した IApplicationBuilderAuthenticationMiddleware を追加します。これにより、認証機能が有効になります。

UseAuthorization(IApplicationBuilder)

指定した IApplicationBuilderAuthorizationMiddleware を追加します。これにより、承認機能が有効になります。

エンドポイント ルーティングを使用してルーティングされるリソースを承認する場合、ミドルウェアが正しく機能するためには、app.UseRouting() 呼び出しと app.UseEndpoints(...) 呼び出しの間にこの呼び出しが表示される必要があります。

UseCertificateForwarding(IApplicationBuilder)

要求ヘッダーで証明書を検索するミドルウェアをパイプラインに追加してデコードし、HttpContext.Connection.ClientCertificate を更新します。

UseBlazorFrameworkFiles(IApplicationBuilder)

ルート パス "/" から Blazor WebAssembly フレームワーク ファイルを提供するようにアプリケーションを構成します。

UseBlazorFrameworkFiles(IApplicationBuilder, PathString)

パス pathPrefixから Blazor WebAssembly フレームワーク ファイルを提供するようにアプリケーションを構成します。 このパスは、参照先の Blazor WebAssembly アプリケーション プロジェクトに対応している必要があります。

UseConcurrencyLimiter(IApplicationBuilder)
古い.

同時に実行される要求の数を制限する ConcurrencyLimiterMiddleware を追加します。

UseConnections(IApplicationBuilder, Action<ConnectionsRouteBuilder>)
古い.

ASP.NET コア接続ハンドラーのサポートを IApplicationBuilder 要求実行パイプラインに追加します。

このメソッドは廃止され、今後のバージョンで削除される予定です。 代わりに、Microsoft.AspNetCore.Builder.UseEndpoints(...) 内で MapConnections または MapConnectionHandler<TConnectionHandler> を使用することをお勧めします。

UseCookiePolicy(IApplicationBuilder)

指定した IApplicationBuilderCookiePolicyMiddleware ハンドラーを追加します。これにより、Cookie ポリシー機能が有効になります。

UseCookiePolicy(IApplicationBuilder, CookiePolicyOptions)

指定した IApplicationBuilderCookiePolicyMiddleware ハンドラーを追加します。これにより、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>)

構成された IEndpointRouteBuilderから構築された EndpointDataSource インスタンスを使用して、指定した IApplicationBuilderMicrosoft.AspNetCore.Routing.EndpointMiddleware ミドルウェアを追加します。 Microsoft.AspNetCore.Routing.EndpointMiddleware は、現在の要求に関連付けられている Endpoint を実行します。

UseRouting(IApplicationBuilder)

指定した IApplicationBuilderMicrosoft.AspNetCore.Routing.EndpointRoutingMiddleware ミドルウェアを追加します。

UseExceptionHandler(IApplicationBuilder)

例外をキャッチし、それらをログに記録し、代替パイプラインで要求を再実行するミドルウェアをパイプラインに追加します。 応答が既に開始されている場合、要求は再実行されません。

UseExceptionHandler(IApplicationBuilder, ExceptionHandlerOptions)

例外をキャッチし、それらをログに記録し、代替パイプラインで要求を再実行するミドルウェアをパイプラインに追加します。 応答が既に開始されている場合、要求は再実行されません。

UseExceptionHandler(IApplicationBuilder, Action<IApplicationBuilder>)

例外をキャッチし、それらをログに記録し、代替パイプラインで要求を再実行するミドルウェアをパイプラインに追加します。 応答が既に開始されている場合、要求は再実行されません。

UseExceptionHandler(IApplicationBuilder, String)

例外をキャッチし、それらをログに記録し、要求パスをリセットし、要求を再実行するミドルウェアをパイプラインに追加します。 応答が既に開始されている場合、要求は再実行されません。

UseExceptionHandler(IApplicationBuilder, String, Boolean)

例外をキャッチし、それらをログに記録し、要求パスをリセットし、要求を再実行するミドルウェアをパイプラインに追加します。 応答が既に開始されている場合、要求は再実行されません。

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)

IApplicationBuilder 要求実行パイプラインに MVC を追加します。

UseMvc(IApplicationBuilder, Action<IRouteBuilder>)

IApplicationBuilder 要求実行パイプラインに MVC を追加します。

UseMvcWithDefaultRoute(IApplicationBuilder)

"default" という名前の既定のルートと、"{controller=Home}/{action=Index}/{id?}" という名前の既定のルートを使用して、MVC を IApplicationBuilder 要求実行パイプラインに追加します。

UseOutputCache(IApplicationBuilder)

HTTP 応答をキャッシュするための Microsoft.AspNetCore.OutputCaching.OutputCacheMiddleware を追加します。

UseOwin(IApplicationBuilder)

指定した IApplicationBuilderに OWIN パイプラインを追加します。

UseOwin(IApplicationBuilder, Action<Action<Func<Func<IDictionary<String,Object>,Task>,Func<IDictionary<String,Object>,Task>>>>)

指定した IApplicationBuilderに OWIN ミドルウェア パイプラインを追加します。

UseRateLimiter(IApplicationBuilder)

アプリケーションのレート制限を有効にします。

UseRateLimiter(IApplicationBuilder, RateLimiterOptions)

アプリケーションのレート制限を有効にします。

UseRequestDecompression(IApplicationBuilder)

HTTP 要求本文を動的に展開するためのミドルウェアを追加します。

UseRequestTimeouts(IApplicationBuilder)

アプリケーションの要求タイムアウトを有効にします。

既定では、タイムアウトは構成されません。 これらは、RequestTimeoutOptions、エンドポイントの RequestTimeoutAttribute、または WithRequestTimeout ルーティング拡張機能を使用して構成する必要があります。

UseResponseCaching(IApplicationBuilder)

HTTP 応答をキャッシュするための ResponseCachingMiddleware を追加します。

UseResponseCompression(IApplicationBuilder)

HTTP 応答を動的に圧縮するためのミドルウェアを追加します。

UseRewriter(IApplicationBuilder)

特定の URL がルールと条件に一致するかどうかを確認し、一致時に HttpContext を変更します。

UseRewriter(IApplicationBuilder, RewriteOptions)

特定の URL がルールと条件に一致するかどうかを確認し、一致時に HttpContext を変更します。

UseRouter(IApplicationBuilder, IRouter)

指定した IRouterを使用して、指定した IApplicationBuilderRouterMiddleware ミドルウェアを追加します。

UseRouter(IApplicationBuilder, Action<IRouteBuilder>)

構成された IRouteBuilderから構築された IRouter を使用して、指定した IApplicationBuilderRouterMiddleware ミドルウェアを追加します。

Run(IApplicationBuilder, RequestDelegate)

アプリケーションの要求パイプラインにターミナル ミドルウェア デリゲートを追加します。

UseSession(IApplicationBuilder)

アプリケーションのセッション状態を自動的に有効にする SessionMiddleware を追加します。

UseSession(IApplicationBuilder, SessionOptions)

アプリケーションのセッション状態を自動的に有効にする SessionMiddleware を追加します。

UseSignalR(IApplicationBuilder, Action<HubRouteBuilder>)
古い.

IApplicationBuilder 要求実行パイプラインに SignalR を追加します。

このメソッドは廃止され、今後のバージョンで削除される予定です。 代わりに、Microsoft.AspNetCore.Builder.UseEndpoints(...) 内で MapHub<THub> を使用することをお勧めします。

UseSpa(IApplicationBuilder, Action<ISpaBuilder>)

シングル ページ アプリケーション (SPA) の既定のページを返すことによって、ミドルウェア チェーン内のこのポイントからのすべての要求を処理します。

このミドルウェアは、静的ファイルや MVC アクションなどを処理するための他のミドルウェアが優先されるように、チェーンの後半に配置する必要があります。

UseStaticFiles(IApplicationBuilder)

現在の要求パスに対して静的ファイルサービスを有効にします

UseStaticFiles(IApplicationBuilder, StaticFileOptions)

指定されたオプションを使用して静的ファイルを提供できるようにします

UseStaticFiles(IApplicationBuilder, String)

指定された要求パスに対して静的ファイルサービスを有効にします

UseStatusCodePages(IApplicationBuilder)

本文のない状態コードが 400 ~ 599 の応答をチェックする既定の応答ハンドラーを持つ StatusCodePages ミドルウェアを追加します。

UseStatusCodePages(IApplicationBuilder, StatusCodePagesOptions)

状態コードが 400 から 599 の間で本文がない応答をチェックする特定のオプションを持つ StatusCodePages ミドルウェアを追加します。

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)

Chromium 開発ツール内で Blazor WebAssembly アプリケーションをデバッグするために必要なミドルウェアを追加します。

UseWebpackDevMiddleware(IApplicationBuilder, WebpackDevMiddlewareOptions)
古い.

Webpack 開発ミドルウェアのサポートを有効にします。 これにより、Webpack コンパイラのインスタンスがアプリケーション内のメモリ内でホストされるため、コンパイラを手動で実行しなくても、up-to-date Webpack で構築されたリソースを常に提供できます。 Webpack コンパイラ インスタンスはメモリに保持されるため、インクリメンタル コンパイルは、コンパイラを最初から再実行する方が大幅に高速です。

Webpack でビルドされたファイルに一致する受信要求は、ディスク上のファイルに関係なく、Webpack コンパイラ出力を直接返すことによって処理されます。 要求が到着したときにコンパイルが進行中の場合、更新されたコンパイラ出力の準備ができるまで応答は一時停止します。

UseWebSockets(IApplicationBuilder)

要求パイプラインに WebSocketMiddleware を追加します。

UseWebSockets(IApplicationBuilder, WebSocketOptions)

要求パイプラインに WebSocketMiddleware を追加します。

UseWelcomePage(IApplicationBuilder)

WelcomePageMiddleware をパイプラインに追加します。

UseWelcomePage(IApplicationBuilder, WelcomePageOptions)

指定されたオプションを使用して、WelcomePageMiddleware をパイプラインに追加します。

UseWelcomePage(IApplicationBuilder, PathString)

指定されたパスを使用して、WelcomePageMiddleware をパイプラインに追加します。

UseWelcomePage(IApplicationBuilder, String)

指定されたパスを使用して、WelcomePageMiddleware をパイプラインに追加します。

UseHttpLoggingMiddleware(IApplicationBuilder)

受信 HTTP 要求ログ ミドルウェアを IApplicationBuilderに登録します。

UseRequestCheckpoint(IApplicationBuilder)

要求チェックポイント関連ミドルウェアをパイプラインに登録します。

UseRequestLatencyTelemetry(IApplicationBuilder)

要求の待機時間テレメトリ ミドルウェアを要求実行パイプライン IApplicationBuilder 追加します。

UseSpaStaticFiles(IApplicationBuilder)

シングル ページ アプリケーション (SPA) の静的ファイルを提供するようにアプリケーションを構成します。 ファイルは、登録済みの ISpaStaticFileProvider サービスを使用して配置されます。

UseSpaStaticFiles(IApplicationBuilder, StaticFileOptions)

シングル ページ アプリケーション (SPA) の静的ファイルを提供するようにアプリケーションを構成します。 ファイルは、登録済みの ISpaStaticFileProvider サービスを使用して配置されます。

適用対象