CosmosClientOptions interface

Paket:

@azure/cosmos

Eigenschaften

aadCredentials	AAD-Token aus @azure/identity Abrufen eines Anmeldeinformationsobjekts durch Erstellen eines @azure/identity Anmeldeinformationsobjekts Wir verwenden dann Ihr Anmeldeinformationsobjekt und eine Bereichs-URL (Ihren cosmos db-Endpunkt), um Anforderungen an Cosmos zu authentifizieren.
agent	Ein optionaler benutzerdefinierter HTTP(s)-Agent, der in NodeJS-Enironments verwendet werden soll Verwenden Sie einen Agent, z https://github.com/TooTallNate/node-proxy-agent . B. wenn Sie eine Verbindung mit Cosmos über einen Proxy herstellen müssen.
connectionPolicy	Eine Instanz der ConnectionPolicy-Klasse . Dieser Parameter ist optional, und die standardmäßige connectionPolicy wird verwendet, wenn er nicht angegeben wird.
consistencyLevel	Ein optionaler Parameter, der die Konsistenzebene darstellt. Es kann einen beliebigen Wert aus ConsistencyLevel annehmen.
defaultHeaders
diagnosticLevel
endpoint	Der Dienstendpunkt, der zum Erstellen des Clients verwendet werden soll.
key	Der Kontomaster oder readonly-Schlüssel
permissionFeed	Ein Array von Permission-Objekten .
resourceTokens	Ein -Objekt, das Ressourcentoken enthält. Schlüssel für das -Objekt sind Ressourcen-IDs und Werte die Ressourcentoken.
tokenProvider	Eine vom Benutzer bereitgestellte Funktion zum Auflösen von Headerautorisierungstoken. Ermöglicht Es Benutzern, ihre eigenen Authentifizierungstoken zu generieren, möglicherweise mit einem separaten Dienst.
userAgentSuffix	Eine benutzerdefinierte Zeichenfolge, die an den Standard-SDK-Benutzer-Agent angefügt werden soll.

Details zur Eigenschaft

aadCredentials

AAD-Token aus @azure/identity Abrufen eines Anmeldeinformationsobjekts durch Erstellen eines @azure/identity Anmeldeinformationsobjekts Wir verwenden dann Ihr Anmeldeinformationsobjekt und eine Bereichs-URL (Ihren cosmos db-Endpunkt), um Anforderungen an Cosmos zu authentifizieren.

aadCredentials?: TokenCredential

Eigenschaftswert

TokenCredential

agent

Ein optionaler benutzerdefinierter HTTP(s)-Agent, der in NodeJS-Enironments verwendet werden soll Verwenden Sie einen Agent, z https://github.com/TooTallNate/node-proxy-agent . B. wenn Sie eine Verbindung mit Cosmos über einen Proxy herstellen müssen.

agent?: Agent

Eigenschaftswert

Agent

connectionPolicy

Eine Instanz der ConnectionPolicy-Klasse . Dieser Parameter ist optional, und die standardmäßige connectionPolicy wird verwendet, wenn er nicht angegeben wird.

connectionPolicy?: ConnectionPolicy

Eigenschaftswert

ConnectionPolicy

consistencyLevel

Ein optionaler Parameter, der die Konsistenzebene darstellt. Es kann einen beliebigen Wert aus ConsistencyLevel annehmen.

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

Eigenschaftswert

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

defaultHeaders

defaultHeaders?: CosmosHeaders_2

Eigenschaftswert

CosmosHeaders_2

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Eigenschaftswert

CosmosDbDiagnosticLevel

endpoint

Der Dienstendpunkt, der zum Erstellen des Clients verwendet werden soll.

endpoint: string

Eigenschaftswert

string

key

Der Kontomaster oder readonly-Schlüssel

key?: string

Eigenschaftswert

string

permissionFeed

Ein Array von Permission-Objekten .

permissionFeed?: PermissionDefinition[]

Eigenschaftswert

PermissionDefinition[]

resourceTokens

Ein -Objekt, das Ressourcentoken enthält. Schlüssel für das -Objekt sind Ressourcen-IDs und Werte die Ressourcentoken.

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

Eigenschaftswert

{[resourcePath: string]: string}

tokenProvider

Eine vom Benutzer bereitgestellte Funktion zum Auflösen von Headerautorisierungstoken. Ermöglicht Es Benutzern, ihre eigenen Authentifizierungstoken zu generieren, möglicherweise mit einem separaten Dienst.

tokenProvider?: TokenProvider

Eigenschaftswert

TokenProvider

userAgentSuffix

Eine benutzerdefinierte Zeichenfolge, die an den Standard-SDK-Benutzer-Agent angefügt werden soll.

userAgentSuffix?: string

Eigenschaftswert

string