DatabaseAccountCreateUpdateParameters interface

الحزمة:

@azure/arm-cosmosdb

معلمات لإنشاء حسابات قاعدة بيانات Cosmos DB وتحديثها.

يمتد

ARMResourceProperties

الخصائص

analyticalStorageConfiguration	خصائص محددة للتخزين التحليلي.
apiProperties	خصائص محددة لواجهة برمجة التطبيقات. حاليا، مدعوم فقط لواجهة برمجة تطبيقات MongoDB.
backupPolicy	الكائن الذي يمثل نهج أخذ النسخ الاحتياطية على حساب.
capabilities	قائمة قدرات Cosmos DB للحساب
capacity	الكائن الذي يمثل جميع الخصائص المتعلقة بتطبيق السعة على حساب.
capacityMode	يشير إلى capacityMode لحساب Cosmos DB.
connectorOffer	نوع عرض موصل cassandra لحساب قاعدة بيانات Cosmos DB C*.
consistencyPolicy	نهج التناسق لحساب Cosmos DB.
cors	نهج CORS لحساب قاعدة بيانات Cosmos DB.
createMode	تعداد للإشارة إلى وضع إنشاء الحساب.
customerManagedKeyStatus	يشير إلى حالة ميزة المفتاح المدار للعميل على الحساب. في حالة وجود أخطاء، توفر الخاصية إرشادات استكشاف الأخطاء وإصلاحها.
databaseAccountOfferType	نوع العرض لقاعدة البيانات
defaultIdentity	الهوية الافتراضية للوصول إلى خزنة المفاتيح المستخدمة في ميزات مثل المفاتيح المدارة من قبل العميل. يجب تعيين الهوية الافتراضية بشكل صريح من قبل المستخدمين. يمكن أن يكون "FirstPartyIdentity" و"SystemAssignedIdentity" والمزيد.
defaultPriorityLevel	تعداد للإشارة إلى مستوى الأولوية الافتراضي لطلب التنفيذ المستند إلى الأولوية.
diagnosticLogSettings	الكائن الذي يمثل إعدادات سجل التشخيص المختلفة لحساب Cosmos DB.
disableKeyBasedMetadataWriteAccess	تعطيل عمليات الكتابة على موارد بيانات التعريف (قواعد البيانات والحاويات ومعدل النقل) عبر مفاتيح الحساب
disableLocalAuth	إلغاء الاشتراك في المصادقة المحلية والتأكد من أن MSI وAD فقط يمكن استخدامهما حصريا للمصادقة.
enableAllVersionsAndDeletesChangeFeed	وضع علامة للإشارة إلى ما إذا كانت ميزة تغيير جميع الإصدارات والحذف ممكنة على الحساب
enableAnalyticalStorage	ضع علامة للإشارة إلى ما إذا كان يجب تمكين تحليلات التخزين.
enableAutomaticFailover	تمكين تجاوز الفشل التلقائي لمنطقة الكتابة في الحدث النادر الذي لا تتوفر فيه المنطقة بسبب انقطاع التيار الكهربائي. سيؤدي تجاوز الفشل التلقائي إلى منطقة كتابة جديدة للحساب ويتم اختياره استنادا إلى أولويات تجاوز الفشل التي تم تكوينها للحساب.
enableBurstCapacity	وضع علامة للإشارة إلى تمكين/تعطيل ميزة معاينة سعة الاندفاع على الحساب
enableCassandraConnector	تمكين موصل cassandra على حساب Cosmos DB C*
enableFreeTier	ضع علامة للإشارة إلى ما إذا كان المستوى المجاني ممكنا أم لا.
enableMaterializedViews	وضع علامة للإشارة إلى ما إذا كان يجب تمكين MaterializedViews على حساب Cosmos DB
enableMultipleWriteLocations	تمكين الحساب من الكتابة في مواقع متعددة
enablePartitionMerge	وضع علامة للإشارة إلى تمكين/تعطيل ميزة دمج الأقسام على الحساب
enablePerRegionPerPartitionAutoscale	وضع علامة للإشارة إلى تمكين/تعطيل ميزة معاينة التحجيم التلقائي لكل قسم Per-Region على الحساب
enablePriorityBasedExecution	وضع علامة للإشارة إلى تمكين/تعطيل ميزة معاينة التنفيذ المستندة إلى الأولوية على الحساب
ipRules	قائمة IpRules.
isVirtualNetworkFilterEnabled	ضع علامة للإشارة إلى ما إذا كان يجب تمكين/تعطيل قواعد ACL للشبكة الظاهرية.
keysMetadata	يتم تجاهل هذه الخاصية أثناء عملية التحديث/الإنشاء، حيث إن بيانات التعريف للقراءة فقط. يمثل الكائن بيانات التعريف لمفاتيح الحساب لحساب Cosmos DB. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
keyVaultKeyUri	عنوان URI لمخزن المفاتيح
kind	يشير إلى نوع حساب قاعدة البيانات. يمكن تعيين هذا فقط عند إنشاء حساب قاعدة البيانات.
locations	صفيف يحتوي على مواقع التبسيط الجغرافي الممكنة لحساب Cosmos DB.
minimalTlsVersion	يشير إلى الحد الأدنى المسموح به لإصدار Tls. الإعداد الافتراضي هو Tls 1.0، باستثناء Cassandra وMongo API، والتي تعمل فقط مع Tls 1.2.
networkAclBypass	يشير إلى الخدمات المسموح لها بتجاوز عمليات التحقق من جدار الحماية.
networkAclBypassResourceIds	صفيف يحتوي على معرفات الموارد لتجاوز Network Acl لحساب Cosmos DB.
publicNetworkAccess	ما إذا كان مسموحا بالطلبات الواردة من الشبكة العامة
restoreParameters	معلمات للإشارة إلى معلومات حول الاستعادة.
virtualNetworkRules	قائمة قواعد ACL للشبكة الظاهرية التي تم تكوينها لحساب Cosmos DB.

الخصائص الموروثة

id	معرف المورد الفريد لمورد ARM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
identity	هوية المورد.
location	موقع مجموعة الموارد التي ينتمي إليها المورد.
name	اسم مورد ARM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
tags	العلامات هي قائمة أزواج قيم المفاتيح التي تصف المورد. يمكن استخدام هذه العلامات في عرض هذا المورد وتجميعه (عبر مجموعات الموارد). يمكن توفير 15 علامة كحد أقصى لمورد. يجب أن تحتوي كل علامة على مفتاح لا يزيد عن 128 حرفا وقيمة لا تزيد عن 256 حرفا. على سبيل المثال، يتم تعيين التجربة الافتراضية لنوع قالب مع "defaultExperience": "Cassandra". تتضمن قيم "defaultExperience" الحالية أيضا "Table" و"Graph" و"DocumentDB" و"MongoDB".
type	نوع مورد Azure. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

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

analyticalStorageConfiguration

خصائص محددة للتخزين التحليلي.

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

قيمة الخاصية

AnalyticalStorageConfiguration

apiProperties

خصائص محددة لواجهة برمجة التطبيقات. حاليا، مدعوم فقط لواجهة برمجة تطبيقات MongoDB.

apiProperties?: ApiProperties

قيمة الخاصية

ApiProperties

backupPolicy

الكائن الذي يمثل نهج أخذ النسخ الاحتياطية على حساب.

backupPolicy?: BackupPolicyUnion

قيمة الخاصية

BackupPolicyUnion

capabilities

قائمة قدرات Cosmos DB للحساب

capabilities?: Capability[]

قيمة الخاصية

Capability[]

capacity

الكائن الذي يمثل جميع الخصائص المتعلقة بتطبيق السعة على حساب.

capacity?: Capacity

قيمة الخاصية

Capacity

capacityMode

يشير إلى capacityMode لحساب Cosmos DB.

capacityMode?: string

قيمة الخاصية

string

connectorOffer

نوع عرض موصل cassandra لحساب قاعدة بيانات Cosmos DB C*.

connectorOffer?: string

قيمة الخاصية

string

consistencyPolicy

نهج التناسق لحساب Cosmos DB.

consistencyPolicy?: ConsistencyPolicy

قيمة الخاصية

ConsistencyPolicy

cors

نهج CORS لحساب قاعدة بيانات Cosmos DB.

cors?: CorsPolicy[]

قيمة الخاصية

CorsPolicy[]

createMode

تعداد للإشارة إلى وضع إنشاء الحساب.

createMode?: string

قيمة الخاصية

string

customerManagedKeyStatus

يشير إلى حالة ميزة المفتاح المدار للعميل على الحساب. في حالة وجود أخطاء، توفر الخاصية إرشادات استكشاف الأخطاء وإصلاحها.

customerManagedKeyStatus?: string

قيمة الخاصية

string

databaseAccountOfferType

نوع العرض لقاعدة البيانات

databaseAccountOfferType: "Standard"

قيمة الخاصية

"Standard"

defaultIdentity

الهوية الافتراضية للوصول إلى خزنة المفاتيح المستخدمة في ميزات مثل المفاتيح المدارة من قبل العميل. يجب تعيين الهوية الافتراضية بشكل صريح من قبل المستخدمين. يمكن أن يكون "FirstPartyIdentity" و"SystemAssignedIdentity" والمزيد.

defaultIdentity?: string

قيمة الخاصية

string

defaultPriorityLevel

تعداد للإشارة إلى مستوى الأولوية الافتراضي لطلب التنفيذ المستند إلى الأولوية.

defaultPriorityLevel?: string

قيمة الخاصية

string

diagnosticLogSettings

الكائن الذي يمثل إعدادات سجل التشخيص المختلفة لحساب Cosmos DB.

diagnosticLogSettings?: DiagnosticLogSettings

قيمة الخاصية

DiagnosticLogSettings

disableKeyBasedMetadataWriteAccess

تعطيل عمليات الكتابة على موارد بيانات التعريف (قواعد البيانات والحاويات ومعدل النقل) عبر مفاتيح الحساب

disableKeyBasedMetadataWriteAccess?: boolean

قيمة الخاصية

boolean

disableLocalAuth

إلغاء الاشتراك في المصادقة المحلية والتأكد من أن MSI وAD فقط يمكن استخدامهما حصريا للمصادقة.

disableLocalAuth?: boolean

قيمة الخاصية

boolean

enableAllVersionsAndDeletesChangeFeed

وضع علامة للإشارة إلى ما إذا كانت ميزة تغيير جميع الإصدارات والحذف ممكنة على الحساب

enableAllVersionsAndDeletesChangeFeed?: boolean

قيمة الخاصية

boolean

enableAnalyticalStorage

ضع علامة للإشارة إلى ما إذا كان يجب تمكين تحليلات التخزين.

enableAnalyticalStorage?: boolean

قيمة الخاصية

boolean

enableAutomaticFailover

تمكين تجاوز الفشل التلقائي لمنطقة الكتابة في الحدث النادر الذي لا تتوفر فيه المنطقة بسبب انقطاع التيار الكهربائي. سيؤدي تجاوز الفشل التلقائي إلى منطقة كتابة جديدة للحساب ويتم اختياره استنادا إلى أولويات تجاوز الفشل التي تم تكوينها للحساب.

enableAutomaticFailover?: boolean

قيمة الخاصية

boolean

enableBurstCapacity

وضع علامة للإشارة إلى تمكين/تعطيل ميزة معاينة سعة الاندفاع على الحساب

enableBurstCapacity?: boolean

قيمة الخاصية

boolean

enableCassandraConnector

تمكين موصل cassandra على حساب Cosmos DB C*

enableCassandraConnector?: boolean

قيمة الخاصية

boolean

enableFreeTier

ضع علامة للإشارة إلى ما إذا كان المستوى المجاني ممكنا أم لا.

enableFreeTier?: boolean

قيمة الخاصية

boolean

enableMaterializedViews

وضع علامة للإشارة إلى ما إذا كان يجب تمكين MaterializedViews على حساب Cosmos DB

enableMaterializedViews?: boolean

قيمة الخاصية

boolean

enableMultipleWriteLocations

تمكين الحساب من الكتابة في مواقع متعددة

enableMultipleWriteLocations?: boolean

قيمة الخاصية

boolean

enablePartitionMerge

وضع علامة للإشارة إلى تمكين/تعطيل ميزة دمج الأقسام على الحساب

enablePartitionMerge?: boolean

قيمة الخاصية

boolean

enablePerRegionPerPartitionAutoscale

وضع علامة للإشارة إلى تمكين/تعطيل ميزة معاينة التحجيم التلقائي لكل قسم Per-Region على الحساب

enablePerRegionPerPartitionAutoscale?: boolean

قيمة الخاصية

boolean

enablePriorityBasedExecution

وضع علامة للإشارة إلى تمكين/تعطيل ميزة معاينة التنفيذ المستندة إلى الأولوية على الحساب

enablePriorityBasedExecution?: boolean

قيمة الخاصية

boolean

ipRules

قائمة IpRules.

ipRules?: IpAddressOrRange[]

قيمة الخاصية

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

ضع علامة للإشارة إلى ما إذا كان يجب تمكين/تعطيل قواعد ACL للشبكة الظاهرية.

isVirtualNetworkFilterEnabled?: boolean

قيمة الخاصية

boolean

keysMetadata

يتم تجاهل هذه الخاصية أثناء عملية التحديث/الإنشاء، حيث إن بيانات التعريف للقراءة فقط. يمثل الكائن بيانات التعريف لمفاتيح الحساب لحساب Cosmos DB. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

keysMetadata?: DatabaseAccountKeysMetadata

قيمة الخاصية

DatabaseAccountKeysMetadata

keyVaultKeyUri

عنوان URI لمخزن المفاتيح

keyVaultKeyUri?: string

قيمة الخاصية

string

kind

يشير إلى نوع حساب قاعدة البيانات. يمكن تعيين هذا فقط عند إنشاء حساب قاعدة البيانات.

kind?: string

قيمة الخاصية

string

locations

صفيف يحتوي على مواقع التبسيط الجغرافي الممكنة لحساب Cosmos DB.

locations: Location[]

قيمة الخاصية

Location[]

minimalTlsVersion

يشير إلى الحد الأدنى المسموح به لإصدار Tls. الإعداد الافتراضي هو Tls 1.0، باستثناء Cassandra وMongo API، والتي تعمل فقط مع Tls 1.2.

minimalTlsVersion?: string

قيمة الخاصية

string

networkAclBypass

يشير إلى الخدمات المسموح لها بتجاوز عمليات التحقق من جدار الحماية.

networkAclBypass?: NetworkAclBypass

قيمة الخاصية

NetworkAclBypass

networkAclBypassResourceIds

صفيف يحتوي على معرفات الموارد لتجاوز Network Acl لحساب Cosmos DB.

networkAclBypassResourceIds?: string[]

قيمة الخاصية

string[]

publicNetworkAccess

ما إذا كان مسموحا بالطلبات الواردة من الشبكة العامة

publicNetworkAccess?: string

قيمة الخاصية

string

restoreParameters

معلمات للإشارة إلى معلومات حول الاستعادة.

restoreParameters?: RestoreParameters

قيمة الخاصية

RestoreParameters

virtualNetworkRules

قائمة قواعد ACL للشبكة الظاهرية التي تم تكوينها لحساب Cosmos DB.

virtualNetworkRules?: VirtualNetworkRule[]

قيمة الخاصية

VirtualNetworkRule[]

تفاصيل الخاصية الموروثة

id

معرف المورد الفريد لمورد ARM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

id?: string

قيمة الخاصية

string

موروث منARMResourceProperties.id

identity

هوية المورد.

identity?: ManagedServiceIdentity

قيمة الخاصية

ManagedServiceIdentity

موروث منARMResourceProperties.identity

location

موقع مجموعة الموارد التي ينتمي إليها المورد.

location?: string

قيمة الخاصية

string

موروث منARMResourceProperties.location

name

اسم مورد ARM. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

name?: string

قيمة الخاصية

string

موروث منARMResourceProperties.name

tags

العلامات هي قائمة أزواج قيم المفاتيح التي تصف المورد. يمكن استخدام هذه العلامات في عرض هذا المورد وتجميعه (عبر مجموعات الموارد). يمكن توفير 15 علامة كحد أقصى لمورد. يجب أن تحتوي كل علامة على مفتاح لا يزيد عن 128 حرفا وقيمة لا تزيد عن 256 حرفا. على سبيل المثال، يتم تعيين التجربة الافتراضية لنوع قالب مع "defaultExperience": "Cassandra". تتضمن قيم "defaultExperience" الحالية أيضا "Table" و"Graph" و"DocumentDB" و"MongoDB".

tags?: {[propertyName: string]: string}

قيمة الخاصية

{[propertyName: string]: string}

الموروثة منARMResourceProperties.tags

type

نوع مورد Azure. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

type?: string

قيمة الخاصية

string

موروث منARMResourceProperties.type