你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Azure.Cosmos 命名空间

类

AccountConsistency	表示 Azure Cosmos DB 服务的数据库帐户的一致性策略。
AccountProperties	表示 AccountProperties。 AccountProperties 是 Azure Cosmos DB 服务中数据库的容器。
AccountRegion	AccountLocation 类表示特定区域中的 Azure Cosmos DB 数据库帐户。
BoundingBoxProperties	表示 Azure Cosmos DB 服务中几何空间路径的边界框
ChangeFeedEstimator	用于估计部署要读取 ChangeFeedProcessor 的挂起工时。
ChangeFeedEstimatorRequestOptions	的请求选项 ChangeFeedEstimator。
ChangeFeedMode	更改源模式 ChangeFeedRequestOptions的基类。
ChangeFeedProcessor	提供用于启动和停止 ChangeFeedProcessor 由 创建的实例的 Build()API。
ChangeFeedProcessorBuilder	提供了一种灵活的方法，用于创建具有自定义参数集的 实例 ChangeFeedProcessor 。
ChangeFeedProcessorContext	与提供的更改集相关的上下文。
ChangeFeedProcessorState	更改特定分区键范围的源处理器状态。
ChangeFeedProcessorUserException	当 IChangeFeedObserver 中的操作正在运行并由用户代码引发时发生异常
ChangeFeedRequestOptions	Cosmos 更改源请求选项
ChangeFeedStartFrom	在 中 ChangeFeedRequestOptions启动 ChangeFeed 操作的位置的基类。
ClientEncryptionIncludedPath	需要加密的路径以及 中的 ClientEncryptionPolicy关联设置。
ClientEncryptionKey	提供用于按 ID 读取特定客户端数据加密密钥的操作 (又名 ClientEncryptionKey) 。有关创建和枚举客户端加密密钥的操作，请参阅 Database 。 有关 Azure Cosmos DB 中的客户端加密支持的详细信息，请参阅 https://aka.ms/CosmosClientEncryption 。
ClientEncryptionKeyProperties	用于 Azure Cosmos DB 服务的加密密钥的详细信息。
ClientEncryptionKeyResponse	Cosmos DB 服务响应 ClientEncryptionKey 相关请求。
ClientEncryptionPolicy	ClientEncryptionPolicy如果需要加密属于分区键的“id”属性或属性，则应使用 policyFormatVersion 2 和“确定性”加密类型初始化 。 所有分区键属性值都必须是 JSON 字符串。
CompositePath	复合路径的 DOM。 复合路径用于复合索引。 例如，如果要运行“SELECT * FROM c ORDER BY c.age， c.height”之类的查询，则需要将“/age”和“/height”添加为复合索引的复合路径。
ConflictProperties	表示 Azure Cosmos DB 服务中的冲突。
ConflictResolutionPolicy	表示冲突解决策略配置，用于指定在不同区域的写入导致 Azure Cosmos DB 服务容器中的项发生冲突时如何解决冲突。
Conflicts	用于在 Azure Cosmos 容器中读取/查询冲突的操作。
Container	用于按 ID 读取、替换或删除容器中特定现有容器或项的操作。有两种不同类型的操作。 在请求/响应中序列化和反序列化项的对象操作 采用包含 JSON 序列化对象的 Stream 的流响应，并返回包含用于创建新容器和读取/查询所有容器的 Stream See Database 的响应。
ContainerProperties	表示 Azure Cosmos DB 服务中的文档容器。 容器是文档的命名逻辑容器。
ContainerRequestOptions	cosmos 容器请求选项
ContainerResponse	cosmos 容器响应
CosmosClient	提供 Azure Cosmos DB 帐户的客户端逻辑表示形式。 此客户端可用于在 Azure Cosmos DB 数据库服务中配置和执行请求。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。
CosmosClientOptions	定义 CosmosClient 所需的所有可配置选项。
CosmosClientTelemetryOptions	Cosmos 客户端的遥测选项，用于启用/禁用遥测和分布式跟踪以及相应的阈值。
CosmosDiagnostics	包含对 Azure Cosmos DB 服务的当前请求的 cosmos 诊断信息。
CosmosException	Cosmos 客户端异常
CosmosLinqSerializerOptions	此类提供了一种配置 Linq 序列化属性的方法
CosmosOperationCanceledException	当线程取消一个正在执行的操作时在线程中引发的异常。 这会扩展 OperationCanceledException，以包括已取消的操作诊断。
CosmosResponseFactory	此响应工厂使用 CosmosClient 序列化程序将响应消息转换为相应的类型响应
CosmosSerializationOptions	此类提供了一种配置基本序列化程序设置的方法。
CosmosSerializer	这是一个接口，允许 CosmosClient 使用自定义序列化程序
CosmosThresholdOptions	分布式跟踪的阈值
Database	读取或删除现有数据库的操作。 有关创建新数据库和读取/查询所有数据库，请参阅 Client ;使用 client.Databases。
DatabaseProperties	表示 Azure Cosmos DB 帐户中的数据库。
DatabaseResponse	cosmos 数据库响应
DedicatedGatewayRequestOptions	专用网关请求选项
EncryptionKeyWrapMetadata	可用于使用客户管理的密钥包装/解包数据加密密钥的元数据。 有关 Azure Cosmos DB 中的客户端加密支持的详细信息，请参阅 https://aka.ms/CosmosClientEncryption 。
ExcludedPath	指定要在为 Azure Cosmos DB 服务编制数据索引时排除的 JSON 文档中的路径。
FeedIterator	Cosmos 结果集迭代器，用于在检索结果形成查询时跟踪延续标记。
FeedIterator<T>	Cosmos 结果集迭代器，用于在检索结果形成查询时跟踪延续标记。
FeedRange	表示可用作并行单位的源消耗量单位。
FeedResponse<T>	将响应序列化为类型的各种源响应的用户协定。 若要遵循类型化响应的 .NET 标准，应向用户引发任何异常。
GeospatialConfig	表示 Azure Cosmos DB 服务中集合的地理空间配置
Headers	用于请求和响应的标头实现
IncludedPath	指定要包含在 Azure Cosmos DB 服务中的 JSON 文档中的路径。
IndexingPolicy	表示 Azure Cosmos DB 服务中集合的索引策略配置。
ItemRequestOptions	Cosmos 项请求选项
ItemResponse<T>	cosmos 项响应
PartitionKeyBuilder	表示 Azure Cosmos DB 服务中的分区键值列表。
PatchItemRequestOptions	Cosmos Patch 请求选项
PatchOperation	要应用于引用 Cosmos 项的修补操作的详细信息。
PatchOperation<T>	使用值参数定义 PatchOperation。
Permission	用于按 ID 读取、替换或删除特定权限的操作。权限用于创建 ResourceTokens。 资源令牌提供对数据库中应用程序资源的访问权限。 资源令牌： 提供对特定容器、分区键、文档、附件、存储过程、触发器和 UDF 的访问权限。 向用户授予对特定资源的权限时创建。 通过 POST、GET 或 PUT 调用操作权限资源时重新创建。 使用专门针对用户、资源和权限构造的哈希资源令牌。 生存期受到可自定义的有效期的约束。 默认的有效期限为一小时。 但是，可将令牌生存期显式指定为最长 24 个小时。 可以安全替代主密钥。 使客户端能够根据它们的权限读取、写入和删除 Cosmos DB 帐户中的资源。
PermissionProperties	表示 Azure Cosmos DB 服务中的权限。
PermissionResponse	cosmos 权限响应
QueryDefinition	定义 Cosmos SQL 查询
QueryRequestOptions	Cosmos 查询请求选项
ReadManyRequestOptions	Cosmos 查询请求选项
Regions	LocationNames 类包含 Azure Cosmos DB 服务当前支持的 Azure 区域的名称。
RequestHandler	允许定义自定义消息处理程序的抽象。
RequestMessage	表示 Azure Cosmos DB SDK 的处理管道中的请求。
RequestOptions	默认 cosmos 请求选项
Response<T>	cosmos 资源响应类
ResponseMessage	表示来自 Azure Cosmos DB 服务的响应。
ServerSideCumulativeMetrics	从后端接收的查询指标。
ServerSideMetrics	从后端接收的查询指标。
ServerSidePartitionedMetrics	表示特定于单个分区的服务器端指标。
SpatialPath	空间索引规范
ThroughputProperties	表示 Azure Cosmos DB 服务中资源的吞吐量。 它是 Azure Cosmos DB 服务中资源的标准定价。
ThroughputResponse	cosmos 吞吐量响应
TransactionalBatch	表示对容器中具有相同 PartitionKey 项的一批操作，这些项将在 Azure Cosmos DB 服务中以事务方式执行。 使用 CreateTransactionalBatch(PartitionKey) 创建 TransactionalBatch 的实例。
TransactionalBatchItemRequestOptions	RequestOptions ，适用于 中的 TransactionalBatch操作。
TransactionalBatchOperationResult	表示作为请求一部分 TransactionalBatch 的特定操作的结果。
TransactionalBatchOperationResult<T>	表示属于批处理的一部分的特定操作的结果。
TransactionalBatchPatchItemRequestOptions	Cosmos Batch Patch 请求选项
TransactionalBatchRequestOptions	Cosmos 批处理请求选项。
TransactionalBatchResponse	请求的 TransactionalBatch 响应。
UniqueKey	表示 上的唯一键，该键对 Azure Cosmos DB 服务中的集合中的文档强制实施唯一性约束。
UniqueKeyPolicy	表示用于在 Azure Cosmos DB 服务集合中指定文档的唯一性约束的唯一键策略配置。
User	用于按 ID 读取、替换或删除特定现有用户以及查询用户权限的操作。
UserProperties	表示 Azure Cosmos DB 服务中的用户。
UserResponse	cosmos 用户响应

结构

PartitionKey

表示 Azure Cosmos DB 服务中的分区键值。

枚举

CompositePathSortOrder	定义 Azure Cosmos DB 服务中索引路径规范的目标数据类型。
ConflictResolutionMode	指定支持的冲突解决模式，如 中指定 ConflictResolutionPolicy
ConnectionMode	表示客户端在连接到 Azure Cosmos DB 服务时要使用的连接模式。
ConsistencyLevel	这些是 Azure Cosmos DB 服务支持的一致性级别。
CosmosPropertyNamingPolicy	确定用于将基于字符串的名称转换为另一种格式的命名策略，例如首字母为小写的 camel 大小写。
DataType	定义 Azure Cosmos DB 服务中索引路径规范的目标数据类型。
GeospatialType	指定 Azure Cosmos DB 服务中支持的地理空间类型。
IndexingDirective	指定是否对 Azure Cosmos DB 数据库中的资源编制索引。
IndexingMode	指定 Azure Cosmos DB 服务中支持的索引模式。
IndexKind	这些是可用于为 Azure Cosmos DB 服务中的路径编制索引的索引类型。
OperationKind	这些是导致资源版本冲突的操作类型。
PartitionKeyDefinitionVersion	分区版本。
PatchOperationType	介绍修补程序支持的操作类型的列表。
PermissionMode	这些是用于在 Azure Cosmos DB 服务中创建或替换 PermissionProperties 资源的访问权限。
PortReuseMode	传输堆栈使用的端口重用策略选项
SpatialType	定义 Azure Cosmos DB 服务中索引路径规范的目标数据类型。

委托

Container.ChangeFeedHandler<T>	委托以接收执行中的 ChangeFeedProcessor 更改。
Container.ChangeFeedHandlerWithManualCheckpoint<T>	委托以使用手动检查点接收执行中的 ChangeFeedProcessor 更改。
Container.ChangeFeedMonitorErrorDelegate	委托以在更改源操作期间通知错误。
Container.ChangeFeedMonitorLeaseAcquireDelegate	委托以通知更改源处理器正在获取租约的事件。
Container.ChangeFeedMonitorLeaseReleaseDelegate	委托以通知更改源处理器正在释放租约的事件。
Container.ChangeFeedStreamHandler	委托以接收执行中的 ChangeFeedProcessor 更改。
Container.ChangeFeedStreamHandlerWithManualCheckpoint	委托以使用手动检查点接收执行中的 ChangeFeedProcessor 更改。
Container.ChangesEstimationHandler	委托接收关联 ChangeFeedProcessor 实例要读取的挂起更改的估计值。
Container.ChangesHandler<T>	委托以接收执行中的 ChangeFeedProcessor 更改。