CosmosClientOptions interface

Pakket:

@azure/cosmos

Eigenschappen

aadCredentials	AAD-token van @azure/identity Een referentieobject verkrijgen door een @azure/identity referentieobject te maken. Vervolgens gebruiken we 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 zoals https://github.com/TooTallNate/node-proxy-agent als u via een proxy verbinding moet maken met Cosmos
connectionPolicy	Een exemplaar van ConnectionPolicy--klasse. Deze parameter is optioneel en de standaard connectionPolicy wordt gebruikt als u deze weglaat.
consistencyLevel	Een optionele parameter die het consistentieniveau vertegenwoordigt. Het kan elke waarde van ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint	Het service-eindpunt dat moet worden gebruikt om de client te maken.
httpClient	Een optionele aangepaste HttpClient shape om aan te passen hoe aanvragen worden gedaan door de HTTP-pijplijn. Zie @azure/core-rest-pipeline voor meer informatie over het implementeren van deze interface.
key	De accounthoofd- of leessleutel
permissionFeed	Een matrix van Permission-objecten.
resourceTokens	Een object dat resourcestokens bevat. Sleutels voor het object zijn resource-id's en waarden zijn de resourcetokens.
tokenProvider	Een door de gebruiker opgegeven functie 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. Vervolgens gebruiken we 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 zoals https://github.com/TooTallNate/node-proxy-agent als u via een proxy verbinding moet maken met Cosmos

agent?: Agent

Waarde van eigenschap

Agent

connectionPolicy

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

connectionPolicy?: ConnectionPolicy

Waarde van eigenschap

ConnectionPolicy

consistencyLevel

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

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

httpClient

Een optionele aangepaste HttpClient shape om aan te passen hoe aanvragen worden gedaan door de HTTP-pijplijn. Zie @azure/core-rest-pipeline voor meer informatie over het implementeren van deze interface.

httpClient?: HttpClient

Waarde van eigenschap

HttpClient

key

De accounthoofd- of leessleutel

key?: string

Waarde van eigenschap

string

permissionFeed

Een matrix van Permission-objecten.

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 door de gebruiker opgegeven functie 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