CosmosClientOptions interface

Pakket:

@azure/cosmos

Eigenschappen

aadCredentials	AAD-token van @azure/identity Een referentieobject verkrijgen door een @azure/identity referentieobject te maken We gebruiken vervolgens uw referentieobject en een bereik-URL (uw Cosmos db-eindpunt) om aanvragen voor Cosmos te verifiëren
agent	Een optionele aangepaste HTTP(s)-agent die moet worden gebruikt in NodeJS-enironments Gebruik een agent, bijvoorbeeld https://github.com/TooTallNate/node-proxy-agent als u verbinding moet maken met Cosmos via een proxy
connectionPolicy	Een exemplaar van de klasse ConnectionPolicy . Deze parameter is optioneel en de standaard connectionPolicy wordt gebruikt als u dit weglaat.
consistencyLevel	Een optionele parameter die het consistentieniveau vertegenwoordigt. Het kan elke waarde van ConsistencyLevel overnemen.
defaultHeaders
diagnosticLevel
endpoint	Het service-eindpunt dat moet worden gebruikt om de client te maken.
key	De hoofd- of alleen-lezensleutel van het account
permissionFeed	Een matrix met Machtigingsobjecten .
resourceTokens	Een object dat resourcestokens bevat. Sleutels voor het object zijn resource-id's en waarden zijn de resourcetokens.
tokenProvider	Een gebruiker heeft een functie opgegeven voor het omzetten van headerautorisatietokens. Hiermee kunnen gebruikers hun eigen verificatietokens genereren, mogelijk met behulp van een afzonderlijke service
userAgentSuffix	Een aangepaste tekenreeks die moet worden toegevoegd aan de standaard-SDK-gebruikersagent.

Eigenschapdetails

aadCredentials

AAD-token van @azure/identity Een referentieobject verkrijgen door een @azure/identity referentieobject te maken We gebruiken vervolgens uw referentieobject en een bereik-URL (uw Cosmos db-eindpunt) om aanvragen voor Cosmos te verifiëren

aadCredentials?: TokenCredential

Waarde van eigenschap

TokenCredential

agent

Een optionele aangepaste HTTP(s)-agent die moet worden gebruikt in NodeJS-enironments Gebruik een agent, bijvoorbeeld https://github.com/TooTallNate/node-proxy-agent als u verbinding moet maken met Cosmos via een proxy

agent?: Agent

Waarde van eigenschap

Agent

connectionPolicy

Een exemplaar van de klasse ConnectionPolicy . Deze parameter is optioneel en de standaard connectionPolicy wordt gebruikt als u dit weglaat.

connectionPolicy?: ConnectionPolicy

Waarde van eigenschap

ConnectionPolicy

consistencyLevel

Een optionele parameter die het consistentieniveau vertegenwoordigt. Het kan elke waarde van ConsistencyLevel overnemen.

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

Waarde van eigenschap

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

defaultHeaders

defaultHeaders?: CosmosHeaders_2

Waarde van eigenschap

CosmosHeaders_2

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Waarde van eigenschap

CosmosDbDiagnosticLevel

endpoint

Het service-eindpunt dat moet worden gebruikt om de client te maken.

endpoint: string

Waarde van eigenschap

string

key

De hoofd- of alleen-lezensleutel van het account

key?: string

Waarde van eigenschap

string

permissionFeed

Een matrix met Machtigingsobjecten .

permissionFeed?: PermissionDefinition[]

Waarde van eigenschap

PermissionDefinition[]

resourceTokens

Een object dat resourcestokens bevat. Sleutels voor het object zijn resource-id's en waarden zijn de resourcetokens.

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

Waarde van eigenschap

{[resourcePath: string]: string}

tokenProvider

Een gebruiker heeft een functie opgegeven voor het omzetten van headerautorisatietokens. Hiermee kunnen gebruikers hun eigen verificatietokens genereren, mogelijk met behulp van een afzonderlijke service

tokenProvider?: TokenProvider

Waarde van eigenschap

TokenProvider

userAgentSuffix

Een aangepaste tekenreeks die moet worden toegevoegd aan de standaard-SDK-gebruikersagent.

userAgentSuffix?: string

Waarde van eigenschap

string