Package version:

Interface CosmosClientOptions

interface CosmosClientOptions {
    aadCredentials?: TokenCredential;
    agent?: Agent;
    clientEncryptionOptions?: ClientEncryptionOptions;
    connectionPolicy?: ConnectionPolicy;
    connectionString?: string;
    consistencyLevel?:
        | "Strong"
        | "BoundedStaleness"
        | "Session"
        | "Eventual"
        | "ConsistentPrefix";
    defaultHeaders?: CosmosHeaders;
    diagnosticLevel?: CosmosDbDiagnosticLevel;
    endpoint?: string;
    httpClient?: HttpClient;
    key?: string;
    permissionFeed?: PermissionDefinition[];
    resourceTokens?: {
        [resourcePath: string]: string;
    };
    throughputBucket?: number;
    tokenProvider?: TokenProvider;
    userAgentSuffix?: string;
}

Properties

aadCredentials? agent? clientEncryptionOptions? connectionPolicy? connectionString? consistencyLevel? defaultHeaders? diagnosticLevel? endpoint? httpClient? key? permissionFeed? resourceTokens? throughputBucket? tokenProvider? userAgentSuffix?

Properties

OptionalaadCredentials

aadCredentials?: TokenCredential

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

Optionalagent

agent?: 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

OptionalclientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

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

See

ClientEncryptionOptions

OptionalconnectionPolicy

connectionPolicy?: ConnectionPolicy

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

OptionalconnectionString

connectionString?: string

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

OptionalconsistencyLevel

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

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

OptionaldefaultHeaders

defaultHeaders?: CosmosHeaders

OptionaldiagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Optionalendpoint

endpoint?: string

The service endpoint to use to create the client.

OptionalhttpClient

httpClient?: 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.

Optionalkey

key?: string

The account master or readonly key

OptionalpermissionFeed

permissionFeed?: PermissionDefinition[]

An array of Permission objects.

OptionalresourceTokens

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

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

OptionalthroughputBucket

throughputBucket?: number

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

OptionaltokenProvider

tokenProvider?: TokenProvider

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

OptionaluserAgentSuffix

userAgentSuffix?: string

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

Settings

Member Visibility