CosmosClientOptions interface

Paket:

@azure/cosmos

Properti

aadCredentials	Token AAD dari @azure/identity Dapatkan objek kredensial dengan membuat @azure/identity objek kredensial Kami kemudian akan menggunakan objek kredensial Anda dan URL cakupan (titik akhir cosmos db Anda) untuk mengautentikasi permintaan ke Cosmos
agent	Agen http kustom opsional yang akan digunakan dalam enironmen NodeJS Gunakan agen seperti https://github.com/TooTallNate/node-proxy-agent jika Anda perlu terhubung ke Cosmos melalui proksi
connectionPolicy	Instans kelas ConnectionPolicy . Parameter ini bersifat opsional dan connectionPolicy default akan digunakan jika dihilangkan.
consistencyLevel	Parameter opsional yang mewakili tingkat konsistensi. Ini dapat mengambil nilai apa pun dari ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint	Titik akhir layanan yang digunakan untuk membuat klien.
key	Master akun atau kunci baca-saja
permissionFeed	Array objek Izin .
resourceTokens	Objek yang berisi token sumber daya. Kunci untuk objek adalah Id sumber daya dan nilai adalah token sumber daya.
tokenProvider	Fungsi yang disediakan pengguna untuk menyelesaikan token otorisasi header. Memungkinkan pengguna untuk menghasilkan token autentikasi mereka sendiri, berpotensi menggunakan layanan terpisah
userAgentSuffix	String kustom untuk ditambahkan ke agen pengguna SDK default.

Detail Properti

aadCredentials

Token AAD dari @azure/identity Dapatkan objek kredensial dengan membuat @azure/identity objek kredensial Kami kemudian akan menggunakan objek kredensial Anda dan URL cakupan (titik akhir cosmos db Anda) untuk mengautentikasi permintaan ke Cosmos

aadCredentials?: TokenCredential

Nilai Properti

TokenCredential

agent

Agen http kustom opsional yang akan digunakan dalam enironmen NodeJS Gunakan agen seperti https://github.com/TooTallNate/node-proxy-agent jika Anda perlu terhubung ke Cosmos melalui proksi

agent?: Agent

Nilai Properti

Agent

connectionPolicy

Instans kelas ConnectionPolicy . Parameter ini bersifat opsional dan connectionPolicy default akan digunakan jika dihilangkan.

connectionPolicy?: ConnectionPolicy

Nilai Properti

ConnectionPolicy

consistencyLevel

Parameter opsional yang mewakili tingkat konsistensi. Ini dapat mengambil nilai apa pun dari ConsistencyLevel.

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

Nilai Properti

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

defaultHeaders

defaultHeaders?: CosmosHeaders_2

Nilai Properti

CosmosHeaders_2

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Nilai Properti

CosmosDbDiagnosticLevel

endpoint

Titik akhir layanan yang digunakan untuk membuat klien.

endpoint: string

Nilai Properti

string

key

Master akun atau kunci baca-saja

key?: string

Nilai Properti

string

permissionFeed

Array objek Izin .

permissionFeed?: PermissionDefinition[]

Nilai Properti

PermissionDefinition[]

resourceTokens

Objek yang berisi token sumber daya. Kunci untuk objek adalah Id sumber daya dan nilai adalah token sumber daya.

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

Nilai Properti

{[resourcePath: string]: string}

tokenProvider

Fungsi yang disediakan pengguna untuk menyelesaikan token otorisasi header. Memungkinkan pengguna untuk menghasilkan token autentikasi mereka sendiri, berpotensi menggunakan layanan terpisah

tokenProvider?: TokenProvider

Nilai Properti

TokenProvider

userAgentSuffix

String kustom untuk ditambahkan ke agen pengguna SDK default.

userAgentSuffix?: string

Nilai Properti

string