CosmosClientOptions interface

套件:

@azure/cosmos

屬性

aadCredentials	透過建立 @azure/identity 認證物件從 @azure/identity 取得認證物件的 AAD 權杖 我們接著會使用您的認證物件和範圍 URL (cosmos db 端點) 來驗證對 Cosmos 的要求
agent	選擇性的自訂 HTTP (s) Agent，用於 NodeJS 記憶體保護區使用代理程式，例如 https://github.com/TooTallNate/node-proxy-agent ，如果您需要透過 Proxy 連線到 Cosmos
connectionPolicy	ConnectionPolicy類別的實例。 此參數是選擇性的，如果省略，則會使用預設 connectionPolicy。
consistencyLevel	代表一致性層級的選擇性參數。 它可以從 ConsistencyLevel取得任何值。
defaultHeaders
diagnosticLevel
endpoint	用來建立用戶端的服務端點。
key	帳戶主要或唯讀金鑰
permissionFeed	Permission物件的陣列。
resourceTokens	包含資源權杖的物件。 物件的索引鍵是資源識別碼，而值是資源權杖。
tokenProvider	使用者提供的函式，用於解析標頭授權權杖。 允許使用者產生自己的驗證權杖，可能使用不同的服務
userAgentSuffix	要附加至預設 SDK 使用者代理程式的自訂字串。

屬性詳細資料

aadCredentials

透過建立 @azure/identity 認證物件從 @azure/identity 取得認證物件的 AAD 權杖 我們接著會使用您的認證物件和範圍 URL (cosmos db 端點) 來驗證對 Cosmos 的要求

aadCredentials?: TokenCredential

屬性值

TokenCredential

agent

選擇性的自訂 HTTP (s) Agent，用於 NodeJS 記憶體保護區使用代理程式，例如 https://github.com/TooTallNate/node-proxy-agent ，如果您需要透過 Proxy 連線到 Cosmos

agent?: Agent

屬性值

Agent

connectionPolicy

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

屬性值

CosmosDbDiagnosticLevel

endpoint

用來建立用戶端的服務端點。

endpoint: string

屬性值

string

key

帳戶主要或唯讀金鑰

key?: string

屬性值

string

permissionFeed

Permission物件的陣列。

permissionFeed?: PermissionDefinition[]

屬性值

PermissionDefinition[]

resourceTokens

包含資源權杖的物件。 物件的索引鍵是資源識別碼，而值是資源權杖。

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

屬性值

{[resourcePath: string]: string}

tokenProvider

使用者提供的函式，用於解析標頭授權權杖。 允許使用者產生自己的驗證權杖，可能使用不同的服務

tokenProvider?: TokenProvider

屬性值

TokenProvider

userAgentSuffix

要附加至預設 SDK 使用者代理程式的自訂字串。

userAgentSuffix?: string

屬性值

string