CosmosClientOptions interface

Csomag:

@azure/cosmos

Tulajdonságok

aadCredentials	AAD-jogkivonat @azure/identity a Hitelesítő objektum beszerzése hitelesítőadat-objektum létrehozásával @azure/identity . Ezt követően a hitelesítőadat-objektumot és a hatókör URL-címét (a cosmos db-végpontot) használjuk a Cosmos felé irányuló kérések hitelesítéséhez
agent	Nem kötelező egyéni HTTP-ügynök, amelyet a NodeJS-ben használjon, használjon ügynököt, például https://github.com/TooTallNate/node-proxy-agent ha proxyn keresztül kell csatlakoznia a Cosmoshoz
connectionPolicy	A ConnectionPolicy osztály egy példánya. Ez a paraméter nem kötelező, és kihagyás esetén az alapértelmezett connectionPolicy lesz használva.
consistencyLevel	Nem kötelező paraméter, amely a konzisztenciaszintet jelöli. A Konzisztenciaszint bármely értéket igénybe vehet.
defaultHeaders
diagnosticLevel
endpoint	Az ügyfél létrehozásához használandó szolgáltatásvégpont.
key	A fiók főkiszolgálója vagy az olvasható kulcs
permissionFeed	Engedélyobjektumok tömbje.
resourceTokens	Erőforrás-jogkivonatokat tartalmazó objektum. Az objektum kulcsai az erőforrás-azonosítók, az értékek pedig az erőforrás-jogkivonatok.
tokenProvider	Egy felhasználó által megadott függvény a fejléc-engedélyezési jogkivonatok feloldásához. Lehetővé teszi a felhasználók számára, hogy saját hitelesítési jogkivonatokat hozzanak létre, akár külön szolgáltatást is használva
userAgentSuffix	Egyéni sztring, amely hozzáfűzendő az alapértelmezett SDK-felhasználói ügynökhöz.

Tulajdonság adatai

aadCredentials

AAD-jogkivonat @azure/identity a Hitelesítő objektum beszerzése hitelesítőadat-objektum létrehozásával @azure/identity . Ezt követően a hitelesítőadat-objektumot és a hatókör URL-címét (a cosmos db-végpontot) használjuk a Cosmos felé irányuló kérések hitelesítéséhez

aadCredentials?: TokenCredential

Tulajdonság értéke

TokenCredential

agent

Nem kötelező egyéni HTTP-ügynök, amelyet a NodeJS-ben használjon, használjon ügynököt, például https://github.com/TooTallNate/node-proxy-agent ha proxyn keresztül kell csatlakoznia a Cosmoshoz

agent?: Agent

Tulajdonság értéke

Agent

connectionPolicy

A ConnectionPolicy osztály egy példánya. Ez a paraméter nem kötelező, és kihagyás esetén az alapértelmezett connectionPolicy lesz használva.

connectionPolicy?: ConnectionPolicy

Tulajdonság értéke

ConnectionPolicy

consistencyLevel

Nem kötelező paraméter, amely a konzisztenciaszintet jelöli. A Konzisztenciaszint bármely értéket igénybe vehet.

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

Tulajdonság értéke

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

defaultHeaders

defaultHeaders?: CosmosHeaders_2

Tulajdonság értéke

CosmosHeaders_2

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Tulajdonság értéke

CosmosDbDiagnosticLevel

endpoint

Az ügyfél létrehozásához használandó szolgáltatásvégpont.

endpoint: string

Tulajdonság értéke

string

key

A fiók főkiszolgálója vagy az olvasható kulcs

key?: string

Tulajdonság értéke

string

permissionFeed

Engedélyobjektumok tömbje.

permissionFeed?: PermissionDefinition[]

Tulajdonság értéke

PermissionDefinition[]

resourceTokens

Erőforrás-jogkivonatokat tartalmazó objektum. Az objektum kulcsai az erőforrás-azonosítók, az értékek pedig az erőforrás-jogkivonatok.

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

Tulajdonság értéke

{[resourcePath: string]: string}

tokenProvider

Egy felhasználó által megadott függvény a fejléc-engedélyezési jogkivonatok feloldásához. Lehetővé teszi a felhasználók számára, hogy saját hitelesítési jogkivonatokat hozzanak létre, akár külön szolgáltatást is használva

tokenProvider?: TokenProvider

Tulajdonság értéke

TokenProvider

userAgentSuffix

Egyéni sztring, amely hozzáfűzendő az alapértelmezett SDK-felhasználói ügynökhöz.

userAgentSuffix?: string

Tulajdonság értéke

string