CosmosClientOptions interface

Paket:

@azure/cosmos

Egenskaper

aadCredentials	AAD-token från @azure/identity Hämta ett autentiseringsobjekt genom att skapa ett @azure/identity autentiseringsobjekt Vi använder sedan ditt autentiseringsobjekt och en omfångs-URL (cosmos db-slutpunkten) för att autentisera begäranden till Cosmos
agent	En valfri anpassad http(s)-agent som ska användas i NodeJS-miljöer Använd en agent, till exempel https://github.com/TooTallNate/node-proxy-agent om du behöver ansluta till Cosmos via en proxy
clientEncryptionOptions	Krypteringsprincip för åtgärder som omfattar kryptering måste anges på klienten om du använder kryptering på klientsidan Se ClientEncryptionOptions
connectionPolicy	En instans av klassen ConnectionPolicy. Den här parametern är valfri och standardanslutningpolicyn används om den utelämnas.
connectionString	En valfri parameter som representerar συμβολοσειρά � Databasens συμβολοσειρά σύνδεσ�
consistencyLevel	En valfri parameter som representerar konsekvensnivån. Det kan ta valfritt värde från ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint	Tjänstslutpunkten som ska användas för att skapa klienten.
httpClient	En valfri anpassad HttpClient form för att anpassa hur begäranden görs av HTTP-pipelinen. Mer information om hur du implementerar det här gränssnittet finns i @azure/core-rest-pipeline.
key	Kontohuvudnyckeln eller skrivskyddad nyckel
permissionFeed	En matris med behörighet objekt.
resourceTokens	Ett objekt som innehåller resurstoken. Nycklar för objektet är resurs-ID:er och värden är resurstoken.
throughputBucket	En valfri parameter för att ange bucketnummer för dataflöde. Det här värdet kan åsidosättas på begärandenivå Mer information finns i Cosmos DB bucketing för dataflöde.
tokenProvider	En användarangiven funktion för att matcha auktoriseringstoken för huvuden. Tillåter användare att generera sina egna autentiseringstoken, eventuellt med hjälp av en separat tjänst
userAgentSuffix	En anpassad sträng som ska läggas till i standard-SDK-användaragenten.

Egenskapsinformation

aadCredentials

AAD-token från @azure/identity Hämta ett autentiseringsobjekt genom att skapa ett @azure/identity autentiseringsobjekt Vi använder sedan ditt autentiseringsobjekt och en omfångs-URL (cosmos db-slutpunkten) för att autentisera begäranden till Cosmos

aadCredentials?: TokenCredential

Egenskapsvärde

TokenCredential

agent

En valfri anpassad http(s)-agent som ska användas i NodeJS-miljöer Använd en agent, till exempel https://github.com/TooTallNate/node-proxy-agent om du behöver ansluta till Cosmos via en proxy

agent?: Agent

Egenskapsvärde

Agent

clientEncryptionOptions

Krypteringsprincip för åtgärder som omfattar kryptering måste anges på klienten om du använder kryptering på klientsidan

Se ClientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

Egenskapsvärde

ClientEncryptionOptions

connectionPolicy

En instans av klassen ConnectionPolicy. Den här parametern är valfri och standardanslutningpolicyn används om den utelämnas.

connectionPolicy?: ConnectionPolicy

Egenskapsvärde

ConnectionPolicy

connectionString

En valfri parameter som representerar συμβολοσειρά � Databasens συμβολοσειρά σύνδεσ�

connectionString?: string

Egenskapsvärde

string

consistencyLevel

En valfri parameter som representerar konsekvensnivån. Det kan ta valfritt värde från ConsistencyLevel.

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

Egenskapsvärde

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

defaultHeaders

defaultHeaders?: CosmosHeaders

Egenskapsvärde

CosmosHeaders

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Egenskapsvärde

CosmosDbDiagnosticLevel

endpoint

Tjänstslutpunkten som ska användas för att skapa klienten.

endpoint?: string

Egenskapsvärde

string

httpClient

En valfri anpassad HttpClient form för att anpassa hur begäranden görs av HTTP-pipelinen. Mer information om hur du implementerar det här gränssnittet finns i @azure/core-rest-pipeline.

httpClient?: HttpClient

Egenskapsvärde

HttpClient

key

Kontohuvudnyckeln eller skrivskyddad nyckel

key?: string

Egenskapsvärde

string

permissionFeed

En matris med behörighet objekt.

permissionFeed?: PermissionDefinition[]

Egenskapsvärde

PermissionDefinition[]

resourceTokens

Ett objekt som innehåller resurstoken. Nycklar för objektet är resurs-ID:er och värden är resurstoken.

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

Egenskapsvärde

{[resourcePath: string]: string}

throughputBucket

En valfri parameter för att ange bucketnummer för dataflöde. Det här värdet kan åsidosättas på begärandenivå Mer information finns i Cosmos DB bucketing för dataflöde.

throughputBucket?: number

Egenskapsvärde

number

tokenProvider

En användarangiven funktion för att matcha auktoriseringstoken för huvuden. Tillåter användare att generera sina egna autentiseringstoken, eventuellt med hjälp av en separat tjänst

tokenProvider?: TokenProvider

Egenskapsvärde

TokenProvider

userAgentSuffix

En anpassad sträng som ska läggas till i standard-SDK-användaragenten.

userAgentSuffix?: string

Egenskapsvärde

string