CosmosDbContextOptionsBuilder 类

定义

命名空间:

Microsoft.EntityFrameworkCore.Infrastructure

程序集:

Microsoft.EntityFrameworkCore.Cosmos.dll

包:

Microsoft.EntityFrameworkCore.Cosmos v9.0.0

Source:

CosmosDbContextOptionsBuilder.cs

允许在 上 DbContextOptions执行 Cosmos 特定的配置。

public class CosmosDbContextOptionsBuilder : Microsoft.EntityFrameworkCore.Infrastructure.ICosmosDbContextOptionsBuilderInfrastructure

type CosmosDbContextOptionsBuilder = class
    interface ICosmosDbContextOptionsBuilderInfrastructure

Public Class CosmosDbContextOptionsBuilder
Implements ICosmosDbContextOptionsBuilderInfrastructure

继承

Object

CosmosDbContextOptionsBuilder

实现

ICosmosDbContextOptionsBuilderInfrastructure

注解

此类的实例是从对 的调用 CosmosDbContextOptionsExtensions.UseCosmos{TContext} 返回的，它不是设计为在应用程序代码中直接构造的。

有关详细信息和示例，请参阅 使用 DbContextOptions 和 使用 EF Core 访问 Azure Cosmos DB 。

构造函数

CosmosDbContextOptionsBuilder(DbContextOptionsBuilder)

初始化 CosmosDbContextOptionsBuilder 类的新实例。

方法

ConnectionMode(ConnectionMode)	将上下文配置为使用提供的连接模式。
ContentResponseOnWriteEnabled(Boolean)	将布尔值设置为仅返回 Cosmos DB 响应中写入项操作（如 Create、Upsert、Patch 和 Replace）中的标头和状态代码。 将选项设置为 false 将导致响应具有 null 资源。 这可以通过不通过网络发送回资源并在客户端上对其进行序列化来减少网络和 CPU 负载。
ExecutionStrategy(Func<ExecutionStrategyDependencies,IExecutionStrategy>)	将上下文配置为使用提供的 IExecutionStrategy。
GatewayModeMaxConnectionLimit(Int32)	配置 Azure Cosmos DB 服务中目标服务终结点允许的最大并发连接数。
HttpClientFactory(Func<HttpClient>)	将上下文配置为使用特定 HttpClient 工厂。
IdleTcpConnectionTimeout(TimeSpan)	配置空闲时间，在空闲时间过后关闭未使用的连接。
LimitToEndpoint(Boolean)	将操作限制为提供的终结点。
MaxRequestsPerTcpConnection(Int32)	配置通过单个 TCP 连接同时允许的请求数。 当更多请求同时处于未完成状态时，直接/TCP 客户端将打开其他连接。
MaxTcpConnectionsPerEndpoint(Int32)	配置可向每个 Cosmos DB 后端打开的最大 TCP 连接数。 此设置与 MaxRequestsPerTcpConnection 一起限制同时发送到单个 Cosmos DB 后端的请求数， (MaxRequestsPerTcpConnection x MaxTcpConnectionPerEndpoint) 。
OpenTcpConnectionTimeout(TimeSpan)	配置尝试建立连接所允许的时间量。
PreferredRegions(IReadOnlyList<String>)	将上下文配置为使用异地复制数据库帐户提供的首选区域。
Region(String)	将上下文配置为使用提供的异地复制区域。
RequestTimeout(TimeSpan)	配置连接到 Azure Cosmos DB 服务时的超时。 该数字指定等待网络对等方返回响应的时间。
WebProxy(IWebProxy)	配置用于 Web 请求的代理信息。
WithOption(Func<CosmosOptionsExtension,CosmosOptionsExtension>)	通过克隆用于存储设置的扩展来设置选项。 这可确保生成器不会修改已在其他位置使用的选项。

显式接口实现

ICosmosDbContextOptionsBuilderInfrastructure.OptionsBuilder

获取核心选项生成器。