Sdílet prostřednictvím

CosmosClientOptions interface

  • Reference
Balíček:
@azure/cosmos

Vlastnosti

aadCredentials

Token AAD: @azure/identity Získání objektu přihlašovacích údajů vytvořením objektu @azure/identity přihlašovacích údajů Pak použijeme váš objekt přihlašovacích údajů a adresu URL oboru (koncový bod služby Cosmos DB) k ověřování požadavků na Cosmos.
agent

Volitelný vlastní agent HTTP, který se má použít v enironments NodeJS: Použijte agenta, například https://github.com/TooTallNate/node-proxy-agent pokud se potřebujete připojit ke službě Cosmos přes proxy server.
connectionPolicy

Instance Třídy ConnectionPolicy . Tento parametr je nepovinný a pokud je vynechán, použije se výchozí connectionPolicy.
consistencyLevel

Volitelný parametr, který představuje úroveň konzistence. Může převzít libovolnou hodnotu z ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint

Koncový bod služby, který se má použít k vytvoření klienta.
key

Hlavní klíč účtu nebo klíč jen pro čtení
permissionFeed

Pole objektů oprávnění .
resourceTokens

Objekt, který obsahuje tokeny prostředků. Klíče objektu jsou ID prostředků a hodnoty jsou tokeny prostředků.
tokenProvider

Uživatel zadal funkci pro překlad autorizačních tokenů hlaviček. Umožňuje uživatelům generovat vlastní ověřovací tokeny, potenciálně pomocí samostatné služby.
userAgentSuffix

Vlastní řetězec, který se má připojit k výchozímu uživatelskému agentu sady SDK.

Podrobnosti vlastnosti

aadCredentials

Token AAD: @azure/identity Získání objektu přihlašovacích údajů vytvořením objektu @azure/identity přihlašovacích údajů Pak použijeme váš objekt přihlašovacích údajů a adresu URL oboru (koncový bod služby Cosmos DB) k ověřování požadavků na Cosmos.

aadCredentials?: TokenCredential

Hodnota vlastnosti

TokenCredential

agent

Volitelný vlastní agent HTTP, který se má použít v enironments NodeJS: Použijte agenta, například https://github.com/TooTallNate/node-proxy-agent pokud se potřebujete připojit ke službě Cosmos přes proxy server.

agent?: Agent

Hodnota vlastnosti

Agent

connectionPolicy

Instance Třídy ConnectionPolicy . Tento parametr je nepovinný a pokud je vynechán, použije se výchozí connectionPolicy.

connectionPolicy?: ConnectionPolicy

Hodnota vlastnosti

ConnectionPolicy

consistencyLevel

Volitelný parametr, který představuje úroveň konzistence. Může převzít libovolnou hodnotu z ConsistencyLevel.

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

Hodnota vlastnosti

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

defaultHeaders 

defaultHeaders?: CosmosHeaders_2

Hodnota vlastnosti

CosmosHeaders_2

diagnosticLevel 

diagnosticLevel?: CosmosDbDiagnosticLevel

Hodnota vlastnosti

CosmosDbDiagnosticLevel

endpoint

Koncový bod služby, který se má použít k vytvoření klienta.

endpoint: string

Hodnota vlastnosti

string

key

Hlavní klíč účtu nebo klíč jen pro čtení

key?: string

Hodnota vlastnosti

string

permissionFeed

Pole objektů oprávnění .

permissionFeed?: PermissionDefinition[]

Hodnota vlastnosti

PermissionDefinition[]

resourceTokens

Objekt, který obsahuje tokeny prostředků. Klíče objektu jsou ID prostředků a hodnoty jsou tokeny prostředků.

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

Hodnota vlastnosti

{[resourcePath: string]: string}

tokenProvider

Uživatel zadal funkci pro překlad autorizačních tokenů hlaviček. Umožňuje uživatelům generovat vlastní ověřovací tokeny, potenciálně pomocí samostatné služby.

tokenProvider?: TokenProvider

Hodnota vlastnosti

TokenProvider

userAgentSuffix

Vlastní řetězec, který se má připojit k výchozímu uživatelskému agentu sady SDK.

userAgentSuffix?: string

Hodnota vlastnosti

string