ConfigureWebHostBuilder 类

定义

命名空间:

Microsoft.AspNetCore.Builder

程序集:

Microsoft.AspNetCore.dll

包:

Microsoft.AspNetCore.App.Ref v8.0.0

一个不可 IWebHostBuilder 构建的 WebApplicationBuilder。 使用 Build() 生成 WebApplicationBuilder。

public sealed class ConfigureWebHostBuilder : Microsoft.AspNetCore.Hosting.Infrastructure.ISupportsStartup, Microsoft.AspNetCore.Hosting.IWebHostBuilder

type ConfigureWebHostBuilder = class
    interface IWebHostBuilder
    interface ISupportsStartup

Public NotInheritable Class ConfigureWebHostBuilder
Implements ISupportsStartup, IWebHostBuilder

继承

Object

ConfigureWebHostBuilder

实现

ISupportsStartup IWebHostBuilder

方法

ConfigureAppConfiguration(Action<WebHostBuilderContext,IConfigurationBuilder>)	添加一个委托，用于配置 IConfigurationBuilder 将构造 的 IConfiguration。
ConfigureServices(Action<IServiceCollection>)	添加一个委托，用于为主机或 Web 应用程序配置其他服务。 这可多次进行调用。
ConfigureServices(Action<WebHostBuilderContext,IServiceCollection>)	添加一个委托，用于为主机或 Web 应用程序配置其他服务。 这可多次进行调用。
GetSetting(String)	从配置中获取设置值。
UseSetting(String, String)	在配置中添加或替换设置。

显式接口实现

ISupportsStartup.Configure(Action<IApplicationBuilder>)	一个不可 IWebHostBuilder 构建的 WebApplicationBuilder。 使用 Build() 生成 WebApplicationBuilder。
ISupportsStartup.Configure(Action<WebHostBuilderContext,IApplicationBuilder>)	一个不可 IWebHostBuilder 构建的 WebApplicationBuilder。 使用 Build() 生成 WebApplicationBuilder。
ISupportsStartup.UseStartup(Type)	一个不可 IWebHostBuilder 构建的 WebApplicationBuilder。 使用 Build() 生成 WebApplicationBuilder。
ISupportsStartup.UseStartup<TStartup>(Func<WebHostBuilderContext,TStartup>)	一个不可 IWebHostBuilder 构建的 WebApplicationBuilder。 使用 Build() 生成 WebApplicationBuilder。
IWebHostBuilder.Build()	一个不可 IWebHostBuilder 构建的 WebApplicationBuilder。 使用 Build() 生成 WebApplicationBuilder。

扩展方法

UseAzureAppServices(IWebHostBuilder)	将应用程序配置为使用 Azure AppServices 集成。
CaptureStartupErrors(IWebHostBuilder, Boolean)	设置是否应在 Web 主机的配置设置中捕获启动错误。 启用后，将捕获启动异常，并返回错误页。 如果禁用，将传播启动异常。
PreferHostingUrls(IWebHostBuilder, Boolean)	指示主机是否应侦听 在 上 IWebHostBuilder 配置的 URL，而不是 在 IServer上配置的 URL。
Start(IWebHostBuilder, String[])	启动 Web 主机并侦听指定的 URL。
SuppressStatusMessages(IWebHostBuilder, Boolean)	指定是否应禁止显示启动状态消息。
UseConfiguration(IWebHostBuilder, IConfiguration)	在 Web 主机上使用给定的配置设置。
UseContentRoot(IWebHostBuilder, String)	指定要由 Web 主机使用的内容根目录。
UseEnvironment(IWebHostBuilder, String)	指定 Web 主机要使用的环境。
UseServer(IWebHostBuilder, IServer)	指定 Web 主机要使用的服务器。
UseShutdownTimeout(IWebHostBuilder, TimeSpan)	指定等待 Web 主机关闭的时间量。
UseStartup(IWebHostBuilder, String)	指定包含 Web 主机要使用的启动类型的程序集。
UseUrls(IWebHostBuilder, String[])	指定 Web 主机将侦听的 URL。
UseWebRoot(IWebHostBuilder, String)	指定要由 Web 主机使用的 Web 根目录。
ListenHttpOnAnyPort(IWebHostBuilder)	添加在给定 HTTP 端口上侦听的 Kestrel 服务器实例。
ListenHttpsOnAnyPort(IWebHostBuilder, X509Certificate2)	添加在随机 HTTPS 端口上侦听的 Kestrel 服务器实例。
UseFakeStartup(IWebHostBuilder)	添加一个空的 Startup 类以满足 ASP.NET 检查。
Configure(IWebHostBuilder, Action<IApplicationBuilder>)	指定要用于配置 Web 应用程序的启动方法。
Configure(IWebHostBuilder, Action<WebHostBuilderContext,IApplicationBuilder>)	指定要用于配置 Web 应用程序的启动方法。
ConfigureAppConfiguration(IWebHostBuilder, Action<IConfigurationBuilder>)	添加一个委托，用于配置 IConfigurationBuilder 将构造 的 IConfiguration。
ConfigureLogging(IWebHostBuilder, Action<WebHostBuilderContext,ILoggingBuilder>)	添加一个委托来配置提供的 LoggerFactory。 这可多次进行调用。
ConfigureLogging(IWebHostBuilder, Action<ILoggingBuilder>)	添加一个委托来配置提供的 ILoggingBuilder。 这可多次进行调用。
UseDefaultServiceProvider(IWebHostBuilder, Action<WebHostBuilderContext,ServiceProviderOptions>)	配置默认服务提供程序
UseDefaultServiceProvider(IWebHostBuilder, Action<ServiceProviderOptions>)	配置默认服务提供程序
UseStartup(IWebHostBuilder, Type)	指定 Web 主机要使用的启动类型。
UseStartup<TStartup>(IWebHostBuilder)	指定 Web 主机要使用的启动类型。
UseStartup<TStartup>(IWebHostBuilder, Func<WebHostBuilderContext,TStartup>)	指定一个工厂，用于创建 Web 主机要使用的启动实例。
UseStaticWebAssets(IWebHostBuilder)	将 WebRootFileProvider 配置为使用引用的项目和包定义的静态 Web 资产。
UseHttpSys(IWebHostBuilder)	将 Http.sys 指定为 Web 主机要使用的服务器。
UseHttpSys(IWebHostBuilder, Action<HttpSysOptions>)	将 Http.sys 指定为 Web 主机要使用的服务器。
UseIIS(IWebHostBuilder)	配置在 AspNetCoreModule 后面运行时服务器应侦听的端口和基路径。 应用还将配置为捕获启动错误。
UseIISIntegration(IWebHostBuilder)	配置在 AspNetCoreModule 后面运行时服务器应侦听的端口和基路径。 应用还将配置为捕获启动错误。
ConfigureKestrel(IWebHostBuilder, Action<WebHostBuilderContext,KestrelServerOptions>)	配置 Kestrel 选项，但不注册 IServer。 请参阅 UseKestrel(IWebHostBuilder)。
ConfigureKestrel(IWebHostBuilder, Action<KestrelServerOptions>)	配置 Kestrel 选项，但不注册 IServer。 请参阅 UseKestrel(IWebHostBuilder)。
UseKestrel(IWebHostBuilder)	将 Kestrel 指定为 Web 主机要使用的服务器。
UseKestrel(IWebHostBuilder, Action<WebHostBuilderContext,KestrelServerOptions>)	将 Kestrel 指定为 Web 主机要使用的服务器。
UseKestrel(IWebHostBuilder, Action<KestrelServerOptions>)	将 Kestrel 指定为 Web 主机要使用的服务器。
UseKestrelCore(IWebHostBuilder)	将 Kestrel 指定为 Web 主机要使用的服务器。 包括的自动化功能比 UseKestrel(IWebHostBuilder) 使剪裁更有效 (例如 本机 AOT 方案) 。 如果主机最终依赖于某些缺少的功能，则会尽力尝试按需启用它。 否则，启动主机时将引发包含信息性错误消息的异常。
UseKestrelHttpsConfiguration(IWebHostBuilder)	在 UseKestrelCore(IWebHostBuilder) 方案中，可能需要显式选择使用某些 HTTPS 功能。 例如，如果 ASPNETCORE_URLS 包含地址 https:// ， UseKestrelHttpsConfiguration(IWebHostBuilder) 则会在该终结点上启用 HTTPS 配置。 在 UseKestrel(IWebHostBuilder) 方案中不起作用。
UseNamedPipes(IWebHostBuilder)	指定命名管道作为 Kestrel 要使用的传输。
UseNamedPipes(IWebHostBuilder, Action<NamedPipeTransportOptions>)	指定命名管道作为 Kestrel 要使用的传输。
UseQuic(IWebHostBuilder)	将 Quic 指定为 Kestrel 要使用的传输。
UseQuic(IWebHostBuilder, Action<QuicTransportOptions>)	将 Quic 指定为 Kestrel 要使用的传输。
UseSockets(IWebHostBuilder)	将套接字指定为 Kestrel 要使用的传输。
UseSockets(IWebHostBuilder, Action<SocketTransportOptions>)	将套接字指定为 Kestrel 要使用的传输。
ConfigureTestContainer<TContainer>(IWebHostBuilder, Action<TContainer>)	IWebHostBuilder使用 中servicesConfiguration提供的服务配置实例。
ConfigureTestServices(IWebHostBuilder, Action<IServiceCollection>)	IWebHostBuilder使用 中servicesConfiguration提供的服务配置实例。
UseSolutionRelativeContentRoot(IWebHostBuilder, String, String)	设置 的内容根相对于 solutionRelativePath。
UseSolutionRelativeContentRoot(IWebHostBuilder, String, String, String)	设置 的内容根相对于 solutionRelativePath。
UseTestServer(IWebHostBuilder)	启用服务 TestServer 。
UseTestServer(IWebHostBuilder, Action<TestServerOptions>)	启用服务 TestServer 。