CosmosClientOptions interface

Csomag:

@azure/cosmos

Tulajdonságok

aadCredentials	AAD-jogkivonat @azure/identity Hitelesítő objektum beszerzése @azure/identity hitelesítő objektum létrehozásával Ezt követően a hitelesítő objektumot és a hatókör URL-címét (a cosmos db-végpontot) használjuk a Cosmos felé irányuló kérelmek hitelesítéséhez
agent	NodeJS-környezetekben használható opcionális egyéni http(s)-ügynök Használjon ügynököt, például https://github.com/TooTallNate/node-proxy-agent ha proxyn keresztül kell csatlakoznia a Cosmoshoz
clientEncryptionOptions	Ügyféloldali titkosítás használata esetén a titkosítással kapcsolatos műveletek titkosítási házirendjét be kell állítani az ügyfélen Lásd: ClientEncryptionOptions
connectionPolicy	ConnectionPolicy osztály egy példánya. Ez a paraméter nem kötelező, és ha nincs megadva, a rendszer az alapértelmezett connectionPolicy értéket használja.
connectionString	A kapcsolati sztringet jelölő opcionális paraméter. Az adatbázis kapcsolati sztring a Azure Portal.
consistencyLevel	Nem kötelező paraméter, amely a konzisztenciaszintet jelöli. A Konzisztenciaszintbármilyen értéket tartalmazhat.
defaultHeaders
diagnosticLevel
endpoint	Az ügyfél létrehozásához használandó szolgáltatásvégpont.
httpClient	Választható egyéni HttpClient alakzat a HTTP-folyamat kéréseinek testreszabásához. A felület implementálásának részleteiért lásd a @azure/core-rest-pipeline.
key	A fiók főkiszolgálója vagy írásvédett kulcsa
permissionFeed	Az Engedély objektumok tömbje.
resourceTokens	Erőforrás-jogkivonatokat tartalmazó objektum. Az objektum kulcsai erőforrás-azonosítók, az értékek pedig az erőforrás-jogkivonatok.
throughputBucket	Nem kötelező paraméter az átviteli sebesség gyűjtőszámának beállításához. Ez az érték felülbírálható a kérelem szintjén További információ: Cosmos DB átviteli sebesség gyűjtő.
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ás használatával
userAgentSuffix	Az alapértelmezett SDK-felhasználói ügynökhöz fűzendő egyéni sztring.

Tulajdonság adatai

aadCredentials

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

aadCredentials?: TokenCredential

Tulajdonság értéke

TokenCredential

agent

NodeJS-környezetekben használható opcionális egyéni http(s)-ügynök 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

clientEncryptionOptions

Ügyféloldali titkosítás használata esetén a titkosítással kapcsolatos műveletek titkosítási házirendjét be kell állítani az ügyfélen

Lásd: ClientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

Tulajdonság értéke

ClientEncryptionOptions

connectionPolicy

ConnectionPolicy osztály egy példánya. Ez a paraméter nem kötelező, és ha nincs megadva, a rendszer az alapértelmezett connectionPolicy értéket használja.

connectionPolicy?: ConnectionPolicy

Tulajdonság értéke

ConnectionPolicy

connectionString

A kapcsolati sztringet jelölő opcionális paraméter. Az adatbázis kapcsolati sztring a Azure Portal.

connectionString?: string

Tulajdonság értéke

string

consistencyLevel

Nem kötelező paraméter, amely a konzisztenciaszintet jelöli. A Konzisztenciaszintbármilyen értéket tartalmazhat.

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

Tulajdonság értéke

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

defaultHeaders

defaultHeaders?: CosmosHeaders

Tulajdonság értéke

CosmosHeaders

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

httpClient

Választható egyéni HttpClient alakzat a HTTP-folyamat kéréseinek testreszabásához. A felület implementálásának részleteiért lásd a @azure/core-rest-pipeline.

httpClient?: HttpClient

Tulajdonság értéke

HttpClient

key

A fiók főkiszolgálója vagy írásvédett kulcsa

key?: string

Tulajdonság értéke

string

permissionFeed

Az Engedély objektumok tömbje.

permissionFeed?: PermissionDefinition[]

Tulajdonság értéke

PermissionDefinition[]

resourceTokens

Erőforrás-jogkivonatokat tartalmazó objektum. Az objektum kulcsai 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}

throughputBucket

Nem kötelező paraméter az átviteli sebesség gyűjtőszámának beállításához. Ez az érték felülbírálható a kérelem szintjén További információ: Cosmos DB átviteli sebesség gyűjtő.

throughputBucket?: number

Tulajdonság értéke

number

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ás használatával

tokenProvider?: TokenProvider

Tulajdonság értéke

TokenProvider

userAgentSuffix

Az alapértelmezett SDK-felhasználói ügynökhöz fűzendő egyéni sztring.

userAgentSuffix?: string

Tulajdonság értéke

string