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

CosmosClientOptions interface

属性

aadCredentials

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

agent

可选自定义 http () 代理用于 NodeJS enironments 使用代理,例如 https://github.com/TooTallNate/node-proxy-agent ,如果需要通过代理连接到 Cosmos

connectionPolicy

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

consistencyLevel

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

defaultHeaders
diagnosticLevel
endpoint

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

key

帐户主密钥或只读密钥

permissionFeed

Permission 对象的数组。

resourceTokens

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

tokenProvider

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

userAgentSuffix

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

属性详细信息

aadCredentials

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

aadCredentials?: TokenCredential

属性值

agent

可选自定义 http () 代理用于 NodeJS enironments 使用代理,例如 https://github.com/TooTallNate/node-proxy-agent ,如果需要通过代理连接到 Cosmos

agent?: Agent

属性值

connectionPolicy

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

connectionPolicy?: ConnectionPolicy

属性值

consistencyLevel

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

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

属性值

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

defaultHeaders

defaultHeaders?: CosmosHeaders_2

属性值

CosmosHeaders_2

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

属性值

endpoint

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

endpoint: string

属性值

string

key

帐户主密钥或只读密钥

key?: string

属性值

string

permissionFeed

Permission 对象的数组。

permissionFeed?: PermissionDefinition[]

属性值

resourceTokens

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

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

属性值

{[resourcePath: string]: string}

tokenProvider

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

tokenProvider?: TokenProvider

属性值

userAgentSuffix

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

userAgentSuffix?: string

属性值

string