CosmosClientOptions interface

Paket:

@azure/cosmos

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

aadCredentials?: TokenCredential

Eigenschaftswert

TokenCredential

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.

agent?: Agent

Eigenschaftswert

Agent

connectionPolicy

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

connectionPolicy?: ConnectionPolicy

Eigenschaftswert

ConnectionPolicy

consistencyLevel

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

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

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.

httpClient?: HttpClient

Eigenschaftswert

HttpClient

key

Der Kontomaster oder die Lesetaste

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 sind die Ressourcentoken.

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.

tokenProvider?: TokenProvider

Eigenschaftswert

TokenProvider

userAgentSuffix

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

userAgentSuffix?: string

Eigenschaftswert

string