Share via

CosmosClientOptions interface

Package:
@azure/cosmos

Properties

aadCredentials

AAD token from @azure/identity Obtain a credential object by creating an @azure/identity credential object We will then use your credential object and a scope URL (your cosmos db endpoint) to authenticate requests to Cosmos
agent

An optional custom http(s) Agent to be used in NodeJS environments Use an agent such as https://github.com/TooTallNate/node-proxy-agent if you need to connect to Cosmos via a proxy
clientEncryptionOptions

encryption policy for operations involving encryption must be set on the client if using client-side encryption

See ClientEncryptionOptions
connectionPolicy

An instance of ConnectionPolicy class. This parameter is optional and the default connectionPolicy will be used if omitted.
connectionString

An optional parameter that represents the connection string. Your database connection string can be found in the Azure Portal.
consistencyLevel

An optional parameter that represents the consistency level. It can take any value from ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint

The service endpoint to use to create the client.
httpClient

An optional custom HttpClient shape to customize how requests are made by the HTTP pipeline. See @azure/core-rest-pipeline for details on how to implement this interface.
key

The account master or readonly key
permissionFeed

An array of Permission objects.
resourceTokens

An object that contains resources tokens. Keys for the object are resource Ids and values are the resource tokens.
throughputBucket

An optional parameter to set throughput bucket number. This value can be overridden at request level For more information, visit Cosmos DB throughput Bucketing.
tokenProvider

A user supplied function for resolving header authorization tokens. Allows users to generating their own auth tokens, potentially using a separate service
userAgentSuffix

A custom string to append to the default SDK user agent.

Property Details

aadCredentials

AAD token from @azure/identity Obtain a credential object by creating an @azure/identity credential object We will then use your credential object and a scope URL (your cosmos db endpoint) to authenticate requests to Cosmos

aadCredentials?: TokenCredential

Property Value

TokenCredential

agent

An optional custom http(s) Agent to be used in NodeJS environments Use an agent such as https://github.com/TooTallNate/node-proxy-agent if you need to connect to Cosmos via a proxy

agent?: Agent

Property Value

Agent

clientEncryptionOptions

encryption policy for operations involving encryption must be set on the client if using client-side encryption

See ClientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

Property Value

ClientEncryptionOptions

connectionPolicy

An instance of ConnectionPolicy class. This parameter is optional and the default connectionPolicy will be used if omitted.

connectionPolicy?: ConnectionPolicy

Property Value

ConnectionPolicy

connectionString

An optional parameter that represents the connection string. Your database connection string can be found in the Azure Portal.

connectionString?: string

Property Value

string

consistencyLevel

An optional parameter that represents the consistency level. It can take any value from ConsistencyLevel.

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

Property Value

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

defaultHeaders 

defaultHeaders?: CosmosHeaders

Property Value

CosmosHeaders

diagnosticLevel 

diagnosticLevel?: CosmosDbDiagnosticLevel

Property Value

CosmosDbDiagnosticLevel

endpoint

The service endpoint to use to create the client.

endpoint?: string

Property Value

string

httpClient

An optional custom HttpClient shape to customize how requests are made by the HTTP pipeline. See @azure/core-rest-pipeline for details on how to implement this interface.

httpClient?: HttpClient

Property Value

HttpClient

key

The account master or readonly key

key?: string

Property Value

string

permissionFeed

An array of Permission objects.

permissionFeed?: PermissionDefinition[]

Property Value

PermissionDefinition[]

resourceTokens

An object that contains resources tokens. Keys for the object are resource Ids and values are the resource tokens.

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

Property Value

{[resourcePath: string]: string}

throughputBucket

An optional parameter to set throughput bucket number. This value can be overridden at request level For more information, visit Cosmos DB throughput Bucketing.

throughputBucket?: number

Property Value

number

tokenProvider

A user supplied function for resolving header authorization tokens. Allows users to generating their own auth tokens, potentially using a separate service

tokenProvider?: TokenProvider

Property Value

TokenProvider

userAgentSuffix

A custom string to append to the default SDK user agent.

userAgentSuffix?: string

Property Value

string