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

cosmos 包

参考

包

aio

模块

auth	Azure Cosmos 数据库服务中的授权帮助程序函数。
container	在 Azure Cosmos DB SQL API 服务中创建、读取、更新和删除项。
cosmos_client	在 Azure Cosmos DB SQL API 服务中创建、读取和删除数据库。
database	与 Azure Cosmos DB SQL API 服务中的数据库交互。
diagnostics	用于 Azure Cosmos 数据库服务操作的诊断工具。
documents	Azure Cosmos 数据库服务中文档的类和枚举。
errors	Azure Cosmos 数据库服务中特定于服务的异常。 .. 警告：此模块已弃用。请改用 `azure.cosmos.exceptions`。
exceptions	Azure Cosmos 数据库服务中特定于服务的异常。
http_constants	Azure Cosmos 数据库服务中的 HTTP 常量。
offer	在 Azure Cosmos DB SQL API 服务中创建吞吐量属性。
partition_key	在 Azure Cosmos DB SQL API 服务中创建分区键。
permission	在 Azure Cosmos DB SQL API 服务中创建权限。
scripts	在 Azure Cosmos DB SQL API 服务中创建、读取、更新、删除和执行脚本。
user	在 Azure Cosmos DB SQL API 服务中创建、读取、更新和删除用户。

类

ConnectionRetryPolicy
ConsistencyLevel	表示 Azure Cosmos 客户端操作支持的一致性级别。请求的 ConsistencyLevel 必须与为数据库帐户预配的 ConsistencyLevel 匹配或弱。一致性级别。按强度顺序排列的一致性级别为 Strong、BoundedStaleness、Session、ConsistencPrefix 和 Eventual。
ContainerProxy	用于与特定数据库容器交互的接口。不应直接实例化此类。请改用 get_container_client 方法获取现有容器，或使用 create_container 方法创建新容器。 Azure Cosmos DB SQL API 数据库中的容器是文档集合，其中每个文档都表示为一个项。
CosmosClient	Azure Cosmos DB 帐户的客户端逻辑表示形式。使用此客户端配置和执行对 Azure Cosmos DB 服务的请求。建议在应用程序的生存期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 CosmosClient 初始化是一项繁重的操作 - 不要使用初始化 CosmosClient 实例作为凭据或网络连接验证。实例化新的 CosmosClient。
DataType	指定索引规格的数据类型。
DatabaseAccount	数据库帐户。 DatabaseAccount 是数据库的容器。
DatabaseProxy	用于与特定数据库交互的接口。不应直接实例化此类。请改用 get_database_client 方法。数据库包含一个或多个容器，每个容器可以包含项、存储过程、触发器和用户定义的函数。数据库还可以具有关联的用户，其中每个用户都配置了一组用于访问某些容器、存储过程、触发器、用户定义函数或项的权限。 Azure Cosmos DB SQL API 数据库具有以下系统生成的属性。这些属性是只读的： _rid：资源 ID。 _ts：上次更新资源的时间。高值是一个时间戳。 _self：资源的唯一可寻址 URI。 _etag：乐观并发控制所需的资源 etag。 _colls：集合资源的可寻址路径。 _users：用户资源的可寻址路径。
IndexKind	指定索引规范的索引类型。
IndexingMode	指定支持的索引模式。
PartitionKey	用于将容器分区为逻辑分区的键。有关如何选择分区键的信息，请参阅 https://docs.microsoft.com/azure/cosmos-db/partitioning-overview#choose-partitionkey 。
Permission	表示 Azure Cosmos DB SQL API 服务中的 Permission 对象。
PermissionMode	指定权限适用性的枚举。
ProxyConfiguration	代理的配置。
SSLConfiguration	SSL 连接的配置。有关详细信息，请参阅https://requests.readthedocs.io/en/master/user/advanced/#ssl-cert-verification。
ScriptsProxy	用于与存储过程交互的接口。不应直接实例化此类。请改用属性 scripts 。
ThroughputProperties	表示 Azure Cosmos DB SQL API 容器中的吞吐量属性。若要读取和更新吞吐量属性，请使用上的 <xref:Container>关联方法。如果配置自动缩放，则需要设置auto_scale_max_throughput，并且auto_scale_increment_percent也可以与它一起设置。不允许将 offer_throughput 的值与自动缩放设置结合使用。
TriggerOperation	指定应对其执行触发器的操作。
TriggerType	指定触发器的类型。
UserProxy	用于与特定用户交互的接口。不应直接实例化此类。请改用 get_user_client 方法。