CosmosClientOptions interface

Pakiet:

@azure/cosmos

Właściwości

aadCredentials	Token usługi AAD z @azure/identity Uzyskiwanie obiektu poświadczeń przez utworzenie obiektu poświadczeń @azure/identity Następnie 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(s) do użycia w środowiskach NodeJS Użyj agenta, takiego jak https://github.com/TooTallNate/node-proxy-agent jeśli musisz nawiązać połączenie z usługą Cosmos za pośrednictwem serwera proxy
clientEncryptionOptions	Zasady szyfrowania dla operacji obejmujących szyfrowanie muszą być ustawione na kliencie, jeśli używane jest szyfrowanie po stronie klienta Zobacz ClientEncryptionOptions
connectionPolicy	Wystąpienie klasy ConnectionPolicy. Ten parametr jest opcjonalny i domyślny parametr connectionPolicy będzie używany w przypadku pominięcia.
connectionString	Opcjonalny parametr reprezentujący parametry połączenia. Parametry połączenia z bazą danych można znaleźć w witrynie Azure Portal.
consistencyLevel	Opcjonalny parametr reprezentujący poziom spójności. Może przyjąć dowolną wartość z ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint	Punkt końcowy usługi używany do utworzenia klienta.
httpClient	Opcjonalny kształt niestandardowego HttpClient w celu dostosowania sposobu wykonywania żądań przez potok HTTP. Aby uzyskać szczegółowe informacje na temat implementowania tego interfejsu, zobacz @azure/core-rest-pipeline.
key	Klucz główny lub klucz tylko do odczytu konta
permissionFeed	Tablica obiektów uprawnienia.
resourceTokens	Obiekt zawierający tokeny zasobów. Klucze dla obiektu to identyfikatory zasobów i wartości to tokeny zasobów.
throughputBucket	Opcjonalny parametr służący do ustawiania numeru zasobnika przepływności. Tę wartość można zastąpić na poziomie żądania Aby uzyskać więcej informacji, odwiedź stronę Zasobnik przepływności usługi Cosmos DB.
tokenProvider	Użytkownik dostarczył funkcję 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łączany do domyślnego agenta użytkownika zestawu SDK.

Szczegóły właściwości

aadCredentials

Token usługi AAD z @azure/identity Uzyskiwanie obiektu poświadczeń przez utworzenie obiektu poświadczeń @azure/identity Następnie 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(s) do użycia w środowiskach NodeJS Użyj agenta, takiego jak https://github.com/TooTallNate/node-proxy-agent jeśli musisz nawiązać połączenie z usługą Cosmos za pośrednictwem serwera proxy

agent?: Agent

Wartość właściwości

Agent

clientEncryptionOptions

Zasady szyfrowania dla operacji obejmujących szyfrowanie muszą być ustawione na kliencie, jeśli używane jest szyfrowanie po stronie klienta

Zobacz ClientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

Wartość właściwości

ClientEncryptionOptions

connectionPolicy

Wystąpienie klasy ConnectionPolicy. Ten parametr jest opcjonalny i domyślny parametr connectionPolicy będzie używany w przypadku pominięcia.

connectionPolicy?: ConnectionPolicy

Wartość właściwości

ConnectionPolicy

connectionString

Opcjonalny parametr reprezentujący parametry połączenia. Parametry połączenia z bazą danych można znaleźć w witrynie Azure Portal.

connectionString?: string

Wartość właściwości

string

consistencyLevel

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

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

Wartość właściwości

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

defaultHeaders

defaultHeaders?: CosmosHeaders

Wartość właściwości

CosmosHeaders

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Wartość właściwości

CosmosDbDiagnosticLevel

endpoint

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

endpoint?: string

Wartość właściwości

string

httpClient

Opcjonalny kształt niestandardowego HttpClient w celu dostosowania sposobu wykonywania żądań przez potok HTTP. Aby uzyskać szczegółowe informacje na temat implementowania tego interfejsu, zobacz @azure/core-rest-pipeline.

httpClient?: HttpClient

Wartość właściwości

HttpClient

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 zawierający tokeny zasobów. Klucze dla obiektu to identyfikatory zasobów i wartości to tokeny zasobów.

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

Wartość właściwości

{[resourcePath: string]: string}

throughputBucket

Opcjonalny parametr służący do ustawiania numeru zasobnika przepływności. Tę wartość można zastąpić na poziomie żądania Aby uzyskać więcej informacji, odwiedź stronę Zasobnik przepływności usługi Cosmos DB.

throughputBucket?: number

Wartość właściwości

number

tokenProvider

Użytkownik dostarczył funkcję 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łączany do domyślnego agenta użytkownika zestawu SDK.

userAgentSuffix?: string

Wartość właściwości

string