CosmosClientOptions interface

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 enironments Use an agent such as https://github.com/TooTallNate/node-proxy-agent if you need to connect to Cosmos via a proxy

connectionPolicy

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

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.

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

agent

An optional custom http(s) Agent to be used in NodeJS enironments 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

connectionPolicy

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

connectionPolicy?: ConnectionPolicy

Property Value

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_2

Property Value

CosmosHeaders_2

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Property Value

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

key

The account master or readonly key

key?: string

Property Value

string

permissionFeed

An array of Permission objects.

permissionFeed?: PermissionDefinition[]

Property Value

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}

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

userAgentSuffix

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

userAgentSuffix?: string

Property Value

string