CosmosClientOptions interface

Paket:

@azure/cosmos

Properti

aadCredentials	Token AAD dari @azure/identity Mendapatkan objek kredensial dengan membuat objek kredensial @azure/identity 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 di lingkungan NodeJS Gunakan agen seperti https://github.com/TooTallNate/node-proxy-agent jika Anda perlu terhubung ke Cosmos melalui proxy
clientEncryptionOptions	Kebijakan enkripsi untuk operasi yang melibatkan enkripsi harus diatur pada klien jika menggunakan enkripsi sisi klien Lihat ClientEncryptionOptions
connectionPolicy	Instans ConnectionPolicy. Parameter ini bersifat opsional dan connectionPolicy default akan digunakan jika dihilangkan.
connectionString	Parameter opsional yang mewakili string koneksi. String koneksi database Anda dapat ditemukan di Azure Portal.
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.
httpClient	Bentuk HttpClient kustom opsional untuk menyesuaikan bagaimana permintaan dibuat oleh alur HTTP. Lihat @azure/core-rest-pipeline untuk detail tentang cara menerapkan antarmuka ini.
key	Master akun atau kunci baca saja
permissionFeed	Array Izin objek.
resourceTokens	Objek yang berisi token sumber daya. Kunci untuk objek adalah Id sumber daya dan nilai adalah token sumber daya.
throughputBucket	Parameter opsional untuk mengatur nomor bucket throughput. Nilai ini dapat ditimpa pada tingkat permintaan Untuk informasi selengkapnya, kunjungi Bucketing throughput Cosmos DB.
tokenProvider	Fungsi yang disediakan pengguna untuk menyelesaikan token otorisasi header. Memungkinkan pengguna menghasilkan token autentikasi mereka sendiri, yang berpotensi menggunakan layanan terpisah
userAgentSuffix	String kustom untuk ditambahkan ke agen pengguna SDK default.

Detail Properti

aadCredentials

Token AAD dari @azure/identity Mendapatkan objek kredensial dengan membuat objek kredensial @azure/identity 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 di lingkungan NodeJS Gunakan agen seperti https://github.com/TooTallNate/node-proxy-agent jika Anda perlu terhubung ke Cosmos melalui proxy

agent?: Agent

Nilai Properti

Agent

clientEncryptionOptions

Kebijakan enkripsi untuk operasi yang melibatkan enkripsi harus diatur pada klien jika menggunakan enkripsi sisi klien

Lihat ClientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

Nilai Properti

ClientEncryptionOptions

connectionPolicy

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

connectionPolicy?: ConnectionPolicy

Nilai Properti

ConnectionPolicy

connectionString

Parameter opsional yang mewakili string koneksi. String koneksi database Anda dapat ditemukan di Azure Portal.

connectionString?: string

Nilai Properti

string

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

Nilai Properti

CosmosHeaders

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Nilai Properti

CosmosDbDiagnosticLevel

endpoint

Titik akhir layanan yang digunakan untuk membuat klien.

endpoint?: string

Nilai Properti

string

httpClient

Bentuk HttpClient kustom opsional untuk menyesuaikan bagaimana permintaan dibuat oleh alur HTTP. Lihat @azure/core-rest-pipeline untuk detail tentang cara menerapkan antarmuka ini.

httpClient?: HttpClient

Nilai Properti

HttpClient

key

Master akun atau kunci baca saja

key?: string

Nilai Properti

string

permissionFeed

Array Izin objek.

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}

throughputBucket

Parameter opsional untuk mengatur nomor bucket throughput. Nilai ini dapat ditimpa pada tingkat permintaan Untuk informasi selengkapnya, kunjungi Bucketing throughput Cosmos DB.

throughputBucket?: number

Nilai Properti

number

tokenProvider

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

tokenProvider?: TokenProvider

Nilai Properti

TokenProvider

userAgentSuffix

String kustom untuk ditambahkan ke agen pengguna SDK default.

userAgentSuffix?: string

Nilai Properti

string