CosmosClientOptions interface

Balíček:

@azure/cosmos

Vlastnosti

aadCredentials	Token AAD z @azure/identity Získání objektu přihlašovacích údajů vytvořením objektu přihlašovacích údajů @azure/identity Pak použijeme objekt přihlašovacích údajů a adresu URL oboru (koncový bod služby Cosmos DB) k ověřování požadavků na Cosmos DB.
agent	Volitelný vlastní agent http(s) pro použití v prostředích NodeJS Použijte agenta, například https://github.com/TooTallNate/node-proxy-agent pokud se potřebujete připojit ke službě Cosmos prostřednictvím proxy serveru
clientEncryptionOptions	Pokud používáte šifrování na straně klienta, musí být v klientovi nastaveny zásady šifrování pro operace zahrnující šifrování Viz ClientEncryptionOptions
connectionPolicy	Instance ConnectionPolicy třídy. Tento parametr je nepovinný a v případě vynechání se použije výchozí connectionPolicy.
connectionString	Volitelný parametr, který představuje připojovací řetězec. Připojovací řetězec databáze najdete na webu Azure Portal.
consistencyLevel	Volitelný parametr, který představuje úroveň konzistence. Může mít libovolnou hodnotu z ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint	Koncový bod služby, který se má použít k vytvoření klienta.
httpClient	Volitelný vlastní HttpClient obrazec pro přizpůsobení způsobu vytváření požadavků kanálem HTTP. Podrobnosti o implementaci tohoto rozhraní najdete v @azure/core-rest-pipeline.
key	Hlavní klíč účtu nebo klíč jen pro čtení
permissionFeed	Pole Oprávnění objekty.
resourceTokens	Objekt, který obsahuje tokeny prostředků. Klíče objektu jsou ID prostředků a hodnoty jsou tokeny prostředků.
throughputBucket	Volitelný parametr pro nastavení čísla intervalu propustnosti. Tuto hodnotu je možné přepsat na úrovni požadavku. Další informace najdete v tématu Segmenting propustnosti služby Cosmos DB.
tokenProvider	Uživatel zadal funkci pro překlad autorizačních tokenů hlaviček. Umožňuje uživatelům generovat vlastní ověřovací tokeny a potenciálně používat samostatnou službu.
userAgentSuffix	Vlastní řetězec pro připojení k výchozímu uživatelskému agentu sady SDK.

Podrobnosti vlastnosti

aadCredentials

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

aadCredentials?: TokenCredential

Hodnota vlastnosti

TokenCredential

agent

Volitelný vlastní agent http(s) pro použití v prostředích NodeJS Použijte agenta, například https://github.com/TooTallNate/node-proxy-agent pokud se potřebujete připojit ke službě Cosmos prostřednictvím proxy serveru

agent?: Agent

Hodnota vlastnosti

Agent

clientEncryptionOptions

Pokud používáte šifrování na straně klienta, musí být v klientovi nastaveny zásady šifrování pro operace zahrnující šifrování

Viz ClientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

Hodnota vlastnosti

ClientEncryptionOptions

connectionPolicy

Instance ConnectionPolicy třídy. Tento parametr je nepovinný a v případě vynechání se použije výchozí connectionPolicy.

connectionPolicy?: ConnectionPolicy

Hodnota vlastnosti

ConnectionPolicy

connectionString

Volitelný parametr, který představuje připojovací řetězec. Připojovací řetězec databáze najdete na webu Azure Portal.

connectionString?: string

Hodnota vlastnosti

string

consistencyLevel

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

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

Hodnota vlastnosti

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

defaultHeaders

defaultHeaders?: CosmosHeaders

Hodnota vlastnosti

CosmosHeaders

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

httpClient

Volitelný vlastní HttpClient obrazec pro přizpůsobení způsobu vytváření požadavků kanálem HTTP. Podrobnosti o implementaci tohoto rozhraní najdete v @azure/core-rest-pipeline.

httpClient?: HttpClient

Hodnota vlastnosti

HttpClient

key

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

key?: string

Hodnota vlastnosti

string

permissionFeed

Pole Oprávnění objekty.

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}

throughputBucket

Volitelný parametr pro nastavení čísla intervalu propustnosti. Tuto hodnotu je možné přepsat na úrovni požadavku. Další informace najdete v tématu Segmenting propustnosti služby Cosmos DB.

throughputBucket?: number

Hodnota vlastnosti

number

tokenProvider

Uživatel zadal funkci pro překlad autorizačních tokenů hlaviček. Umožňuje uživatelům generovat vlastní ověřovací tokeny a potenciálně používat samostatnou službu.

tokenProvider?: TokenProvider

Hodnota vlastnosti

TokenProvider

userAgentSuffix

Vlastní řetězec pro připojení k výchozímu uživatelskému agentu sady SDK.

userAgentSuffix?: string

Hodnota vlastnosti

string