CosmosClientOptions interface

  • Reference
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ého vlastního agenta HTTP, který se má použít ve výjimkách NodeJS, použijte agenta, jako je https://github.com/TooTallNate/node-proxy-agent, pokud se potřebujete připojit ke službě Cosmos prostřednictvím proxy serveru.
connectionPolicy

Instance ConnectionPolicy třídy. Tento parametr je nepovinný a v případě vynechání se použije výchozí connectionPolicy.
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ů.
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ého vlastního agenta HTTP, který se má použít ve výjimkách NodeJS, použijte agenta, jako je 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

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

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_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

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}

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