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	Permission 物件的陣列。
resourceTokens	物件，包含資源令牌。 物件的索引鍵是資源標識符，而值是資源令牌。
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

Permission 物件的陣列。

permissionFeed?: PermissionDefinition[]

屬性值

PermissionDefinition[]

resourceTokens

物件，包含資源令牌。 物件的索引鍵是資源標識符，而值是資源令牌。

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

屬性值

{[resourcePath: string]: string}

throughputBucket

用於設置輸送量存儲桶編號的可選參數。 可以在請求級別重寫此值有關詳細資訊，請訪問 Cosmos DB 輸送量分桶。

throughputBucket?: number

屬性值

number

tokenProvider

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

tokenProvider?: TokenProvider

屬性值

TokenProvider

userAgentSuffix

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

userAgentSuffix?: string

屬性值

string