CosmosClientOptions interface

Pakiet:

@azure/cosmos

Właściwości

aadCredentials	Token usługi AAD z @azure/identity uzyskiwania obiektu poświadczeń przez utworzenie @azure/identity obiektu poświadczeń Użyjemy obiektu poświadczeń i adresu URL zakresu (punktu końcowego usługi Cosmos DB) do uwierzytelniania żądań w usłudze Cosmos
agent	Opcjonalny niestandardowy agent http do użycia w środowiskach NodeJS enironments Użyj agenta, takiego jak https://github.com/TooTallNate/node-proxy-agent w przypadku konieczności nawiązania połączenia z usługą Cosmos za pośrednictwem serwera proxy
connectionPolicy	Wystąpienie klasy ConnectionPolicy . Ten parametr jest opcjonalny, a domyślny parametr connectionPolicy zostanie użyty w przypadku pominięcia.
consistencyLevel	Opcjonalny parametr reprezentujący poziom spójności. Może ona przyjmować dowolną wartość z elementu ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint	Punkt końcowy usługi używany do tworzenia klienta.
key	Klucz główny lub klucz tylko do odczytu konta
permissionFeed	Tablica obiektów Uprawnienia .
resourceTokens	Obiekt, który zawiera tokeny zasobów. Klucze obiektu to identyfikatory zasobów, a wartości to tokeny zasobów.
tokenProvider	Funkcja dostarczona przez użytkownika do rozpoznawania tokenów autoryzacji nagłówka. Umożliwia użytkownikom generowanie własnych tokenów uwierzytelniania, potencjalnie przy użyciu oddzielnej usługi
userAgentSuffix	Ciąg niestandardowy do dołączania do domyślnego agenta użytkownika zestawu SDK.

Szczegóły właściwości

aadCredentials

Token usługi AAD z @azure/identity uzyskiwania obiektu poświadczeń przez utworzenie @azure/identity obiektu poświadczeń Użyjemy obiektu poświadczeń i adresu URL zakresu (punktu końcowego usługi Cosmos DB) do uwierzytelniania żądań w usłudze Cosmos

aadCredentials?: TokenCredential

Wartość właściwości

TokenCredential

agent

Opcjonalny niestandardowy agent http do użycia w środowiskach NodeJS enironments Użyj agenta, takiego jak https://github.com/TooTallNate/node-proxy-agent w przypadku konieczności nawiązania połączenia z usługą Cosmos za pośrednictwem serwera proxy

agent?: Agent

Wartość właściwości

Agent

connectionPolicy

Wystąpienie klasy ConnectionPolicy . Ten parametr jest opcjonalny, a domyślny parametr connectionPolicy zostanie użyty w przypadku pominięcia.

connectionPolicy?: ConnectionPolicy

Wartość właściwości

ConnectionPolicy

consistencyLevel

Opcjonalny parametr reprezentujący poziom spójności. Może ona przyjmować dowolną wartość z elementu ConsistencyLevel.

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

Wartość właściwości

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

defaultHeaders

defaultHeaders?: CosmosHeaders_2

Wartość właściwości

CosmosHeaders_2

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Wartość właściwości

CosmosDbDiagnosticLevel

endpoint

Punkt końcowy usługi używany do tworzenia klienta.

endpoint: string

Wartość właściwości

string

key

Klucz główny lub klucz tylko do odczytu konta

key?: string

Wartość właściwości

string

permissionFeed

Tablica obiektów Uprawnienia .

permissionFeed?: PermissionDefinition[]

Wartość właściwości

PermissionDefinition[]

resourceTokens

Obiekt, który zawiera tokeny zasobów. Klucze obiektu to identyfikatory zasobów, a wartości to tokeny zasobów.

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

Wartość właściwości

{[resourcePath: string]: string}

tokenProvider

Funkcja dostarczona przez użytkownika do rozpoznawania tokenów autoryzacji nagłówka. Umożliwia użytkownikom generowanie własnych tokenów uwierzytelniania, potencjalnie przy użyciu oddzielnej usługi

tokenProvider?: TokenProvider

Wartość właściwości

TokenProvider

userAgentSuffix

Ciąg niestandardowy do dołączania do domyślnego agenta użytkownika zestawu SDK.

userAgentSuffix?: string

Wartość właściwości

string