CosmosClientOptions interface

包:

@azure/cosmos

属性

aadCredentials	@azure/identity AAD 令牌通过创建 @azure/identity 凭据对象来获取凭据对象，然后我们将使用凭据对象和范围 URL（cosmos db 终结点）对 Cosmos 的请求进行身份验证
agent	要在 NodeJS 环境中使用的可选自定义 http（s） 代理使用代理， https://github.com/TooTallNate/node-proxy-agent 例如，如果需要通过代理连接到 Cosmos
clientEncryptionOptions	如果使用客户端加密，则必须在客户端上设置涉及加密的作的加密策略 请参阅 ClientEncryptionOptions
connectionPolicy	ConnectionPolicy 类的实例。 此参数是可选的，如果省略，将使用默认 connectionPolicy。
connectionString	表示连接字符串的可选参数。 可以在 Azure 门户中找到数据库连接字符串。
consistencyLevel	表示一致性级别的可选参数。 它可以从 ConsistencyLevel获取任何值。
defaultHeaders
diagnosticLevel
enablePreviewFeatures	一个用于选择 SDK 预览功能的词典。 预览功能通常不可用，且在成为通用协议前可能会以向后不兼容的方式发生变化;它们不建议用于生产。
endpoint	用于创建客户端的服务终结点。
httpClient	可选的自定义 HttpClient 形状，用于自定义 HTTP 管道发出请求的方式。 有关如何实现此接口的详细信息，请参阅 @azure/core-rest-pipeline。
key	帐户主密钥或只读密钥
permissionFeed	权限 对象的数组。
resourceTokens	包含资源令牌的对象。 对象的键是资源 ID，值是资源令牌。
throughputBucket	用于设置吞吐量存储桶编号的可选参数。 可以在请求级别重写此值有关详细信息，请访问 Cosmos DB 吞吐量分桶。
tokenProvider	用户提供的用于解析标头授权令牌的函数。 允许用户生成自己的身份验证令牌，可能使用单独的服务
userAgentSuffix	要追加到默认 SDK 用户代理的自定义字符串。

属性详细信息

aadCredentials

@azure/identity AAD 令牌通过创建 @azure/identity 凭据对象来获取凭据对象，然后我们将使用凭据对象和范围 URL（cosmos db 终结点）对 Cosmos 的请求进行身份验证

aadCredentials?: TokenCredential

属性值

TokenCredential

agent

要在 NodeJS 环境中使用的可选自定义 http（s） 代理使用代理， https://github.com/TooTallNate/node-proxy-agent 例如，如果需要通过代理连接到 Cosmos

agent?: Agent

属性值

Agent

clientEncryptionOptions

如果使用客户端加密，则必须在客户端上设置涉及加密的作的加密策略

请参阅 ClientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

属性值

ClientEncryptionOptions

connectionPolicy

ConnectionPolicy 类的实例。 此参数是可选的，如果省略，将使用默认 connectionPolicy。

connectionPolicy?: ConnectionPolicy

属性值

ConnectionPolicy

connectionString

表示连接字符串的可选参数。 可以在 Azure 门户中找到数据库连接字符串。

connectionString?: string

属性值

string

consistencyLevel

表示一致性级别的可选参数。 它可以从 ConsistencyLevel获取任何值。

consistencyLevel?: "Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"

属性值

"Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"

defaultHeaders

defaultHeaders?: CosmosHeaders

属性值

CosmosHeaders

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

属性值

CosmosDbDiagnosticLevel

enablePreviewFeatures

一个用于选择 SDK 预览功能的词典。

预览功能通常不可用，且在成为通用协议前可能会以向后不兼容的方式发生变化;它们不建议用于生产。

enablePreviewFeatures?: Record<string, unknown>

属性值

Record<string, unknown>

endpoint

用于创建客户端的服务终结点。

endpoint?: string

属性值

string

httpClient

可选的自定义 HttpClient 形状，用于自定义 HTTP 管道发出请求的方式。 有关如何实现此接口的详细信息，请参阅 @azure/core-rest-pipeline。

httpClient?: HttpClient

属性值

HttpClient

key

帐户主密钥或只读密钥

key?: string

属性值

string

permissionFeed

权限 对象的数组。

permissionFeed?: PermissionDefinition[]

属性值

PermissionDefinition[]

resourceTokens

包含资源令牌的对象。 对象的键是资源 ID，值是资源令牌。

resourceTokens?: {[resourcePath: string]: string}

属性值

{[resourcePath: string]: string}

throughputBucket

用于设置吞吐量存储桶编号的可选参数。 可以在请求级别重写此值有关详细信息，请访问 Cosmos DB 吞吐量分桶。

throughputBucket?: number

属性值

number

tokenProvider

用户提供的用于解析标头授权令牌的函数。 允许用户生成自己的身份验证令牌，可能使用单独的服务

tokenProvider?: TokenProvider

属性值

TokenProvider

userAgentSuffix

要追加到默认 SDK 用户代理的自定义字符串。

userAgentSuffix?: string

属性值

string