Auf Englisch lesen

Freigeben über


CosmosClientOptions interface

Eigenschaften

aadCredentials

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

agent

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

connectionPolicy

Eine Instanz der ConnectionPolicy Klasse. Dieser Parameter ist optional, und die Standardverbindungsrichtlinie wird verwendet, wenn sie weggelassen wird.

consistencyLevel

Ein optionaler Parameter, der die Konsistenzstufe darstellt. Es kann einen beliebigen Wert aus ConsistencyLevelnehmen.

defaultHeaders
diagnosticLevel
endpoint

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

httpClient

Ein optionales benutzerdefiniertes HttpClient-Shape, um anzupassen, wie Anforderungen von der HTTP-Pipeline vorgenommen werden. Ausführliche Informationen zur Implementierung dieser Schnittstelle finden Sie unter @azure/core-rest-pipeline.

key

Der Kontomaster oder die Lesetaste

permissionFeed

Ein Array von Permission-Objekten.

resourceTokens

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

tokenProvider

Ein Benutzer hat eine Funktion zum Auflösen von Headerautorisierungstoken bereitgestellt. Ermöglicht Benutzern, eigene Authentifizierungstoken zu generieren, die möglicherweise einen separaten Dienst verwenden.

userAgentSuffix

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

Details zur Eigenschaft

aadCredentials

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

TypeScript
aadCredentials?: TokenCredential

Eigenschaftswert

agent

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

TypeScript
agent?: Agent

Eigenschaftswert

connectionPolicy

Eine Instanz der ConnectionPolicy Klasse. Dieser Parameter ist optional, und die Standardverbindungsrichtlinie wird verwendet, wenn sie weggelassen wird.

TypeScript
connectionPolicy?: ConnectionPolicy

Eigenschaftswert

consistencyLevel

Ein optionaler Parameter, der die Konsistenzstufe darstellt. Es kann einen beliebigen Wert aus ConsistencyLevelnehmen.

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

Eigenschaftswert

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

defaultHeaders

TypeScript
defaultHeaders?: CosmosHeaders_2

Eigenschaftswert

CosmosHeaders_2

diagnosticLevel

TypeScript
diagnosticLevel?: CosmosDbDiagnosticLevel

Eigenschaftswert

endpoint

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

TypeScript
endpoint: string

Eigenschaftswert

string

httpClient

Ein optionales benutzerdefiniertes HttpClient-Shape, um anzupassen, wie Anforderungen von der HTTP-Pipeline vorgenommen werden. Ausführliche Informationen zur Implementierung dieser Schnittstelle finden Sie unter @azure/core-rest-pipeline.

TypeScript
httpClient?: HttpClient

Eigenschaftswert

key

Der Kontomaster oder die Lesetaste

TypeScript
key?: string

Eigenschaftswert

string

permissionFeed

Ein Array von Permission-Objekten.

TypeScript
permissionFeed?: PermissionDefinition[]

Eigenschaftswert

resourceTokens

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

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

Eigenschaftswert

{[resourcePath: string]: string}

tokenProvider

Ein Benutzer hat eine Funktion zum Auflösen von Headerautorisierungstoken bereitgestellt. Ermöglicht Benutzern, eigene Authentifizierungstoken zu generieren, die möglicherweise einen separaten Dienst verwenden.

TypeScript
tokenProvider?: TokenProvider

Eigenschaftswert

userAgentSuffix

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

TypeScript
userAgentSuffix?: string

Eigenschaftswert

string