CosmosClientOptions interface

الحزمة:

@azure/cosmos

الخصائص

aadCredentials	رمز AAD المميز من @azure/identity الحصول على كائن بيانات اعتماد عن طريق إنشاء كائن بيانات اعتماد @azure/identity سنستخدم بعد ذلك كائن بيانات الاعتماد وعنوان URL للنطاق (نقطة نهاية cosmos db) لمصادقة الطلبات إلى Cosmos
agent	عامل http (s) مخصص اختياري لاستخدامه في بيئات NodeJS استخدم وكيلا ، كما https://github.com/TooTallNate/node-proxy-agent لو كنت بحاجة إلى الاتصال ب Cosmos عبر وكيل
clientEncryptionOptions	يجب تعيين نهج التشفير للعمليات التي تتضمن التشفير على العميل في حالة استخدام التشفير من جانب العميل انظر ClientEncryptionOptions
connectionPolicy	مثيل ConnectionPolicy. هذه المعلمة اختيارية وسيتم استخدام connectionPolicy الافتراضية إذا تم حذفها.
connectionString	معلمة اختيارية تمثل سلسلة الاتصال. يمكن العثور على سلسلة اتصال قاعدة البيانات في مدخل Microsoft Azure.
consistencyLevel	معلمة اختيارية تمثل مستوى التناسق. يمكن أن يستغرق أي قيمة من ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint	نقطة نهاية الخدمة المراد استخدامها لإنشاء العميل.
httpClient	شكل HttpClient مخصص اختياري لتخصيص كيفية إجراء الطلبات بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية HTTP. راجع @azure/core-rest-pipeline للحصول على تفاصيل حول كيفية تنفيذ هذه الواجهة.
key	المفتاح الرئيسي للحساب أو للقراءة فقط
permissionFeed	صفيف من عناصر إذن.
resourceTokens	كائن يحتوي على رموز مميزة للموارد. مفاتيح العنصر هي معرفات الموارد والقيم هي الرموز المميزة للمورد.
throughputBucket	معلمة اختيارية لتعيين رقم حاوية معدل النقل. يمكن تجاوز هذه القيمة على مستوى الطلب لمزيد من المعلومات، تفضل بزيارة مستودع إنتاجية Cosmos DB.
tokenProvider	وظيفة يوفرها المستخدم لحل رموز تخويل الرأس المميزة. يسمح للمستخدمين بإنشاء رموز المصادقة المميزة الخاصة بهم، ومن المحتمل أن يستخدموا خدمة منفصلة
userAgentSuffix	سلسلة مخصصة لإلحاقها بعامل مستخدم SDK الافتراضي.

تفاصيل الخاصية

aadCredentials

رمز AAD المميز من @azure/identity الحصول على كائن بيانات اعتماد عن طريق إنشاء كائن بيانات اعتماد @azure/identity سنستخدم بعد ذلك كائن بيانات الاعتماد وعنوان URL للنطاق (نقطة نهاية cosmos db) لمصادقة الطلبات إلى Cosmos

aadCredentials?: TokenCredential

قيمة الخاصية

TokenCredential

agent

عامل http (s) مخصص اختياري لاستخدامه في بيئات NodeJS استخدم وكيلا ، كما https://github.com/TooTallNate/node-proxy-agent لو كنت بحاجة إلى الاتصال ب Cosmos عبر وكيل

agent?: Agent

قيمة الخاصية

Agent

clientEncryptionOptions

يجب تعيين نهج التشفير للعمليات التي تتضمن التشفير على العميل في حالة استخدام التشفير من جانب العميل

انظر ClientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

قيمة الخاصية

ClientEncryptionOptions

connectionPolicy

مثيل ConnectionPolicy. هذه المعلمة اختيارية وسيتم استخدام connectionPolicy الافتراضية إذا تم حذفها.

connectionPolicy?: ConnectionPolicy

قيمة الخاصية

ConnectionPolicy

connectionString

معلمة اختيارية تمثل سلسلة الاتصال. يمكن العثور على سلسلة اتصال قاعدة البيانات في مدخل Microsoft Azure.

connectionString?: string

قيمة الخاصية

string

consistencyLevel

معلمة اختيارية تمثل مستوى التناسق. يمكن أن يستغرق أي قيمة من ConsistencyLevel.

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

قيمة الخاصية

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

defaultHeaders

defaultHeaders?: CosmosHeaders

قيمة الخاصية

CosmosHeaders

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

قيمة الخاصية

CosmosDbDiagnosticLevel

endpoint

نقطة نهاية الخدمة المراد استخدامها لإنشاء العميل.

endpoint?: string

قيمة الخاصية

string

httpClient

شكل HttpClient مخصص اختياري لتخصيص كيفية إجراء الطلبات بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية HTTP. راجع @azure/core-rest-pipeline للحصول على تفاصيل حول كيفية تنفيذ هذه الواجهة.

httpClient?: HttpClient

قيمة الخاصية

HttpClient

key

المفتاح الرئيسي للحساب أو للقراءة فقط

key?: string

قيمة الخاصية

string

permissionFeed

صفيف من عناصر إذن.

permissionFeed?: PermissionDefinition[]

قيمة الخاصية

PermissionDefinition[]

resourceTokens

كائن يحتوي على رموز مميزة للموارد. مفاتيح العنصر هي معرفات الموارد والقيم هي الرموز المميزة للمورد.

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

قيمة الخاصية

{[resourcePath: string]: string}

throughputBucket

معلمة اختيارية لتعيين رقم حاوية معدل النقل. يمكن تجاوز هذه القيمة على مستوى الطلب لمزيد من المعلومات، تفضل بزيارة مستودع إنتاجية Cosmos DB.

throughputBucket?: number

قيمة الخاصية

number

tokenProvider

وظيفة يوفرها المستخدم لحل رموز تخويل الرأس المميزة. يسمح للمستخدمين بإنشاء رموز المصادقة المميزة الخاصة بهم، ومن المحتمل أن يستخدموا خدمة منفصلة

tokenProvider?: TokenProvider

قيمة الخاصية

TokenProvider

userAgentSuffix

سلسلة مخصصة لإلحاقها بعامل مستخدم SDK الافتراضي.

userAgentSuffix?: string

قيمة الخاصية

string