SearchServiceUpdate interface

الحزمة:

@azure/arm-search

المعلمات المستخدمة لتحديث azure Cognitive خدمة البحث.

Extends

Resource

الخصائص

authOptions	يحدد خيارات كيفية مصادقة واجهة برمجة تطبيقات مستوى البيانات لخدمة البحث للطلبات. لا يمكن تعيين هذا إذا تم تعيين "disableLocalAuth" إلى true.
disableLocalAuth	عند التعيين إلى صحيح، لن يسمح للمكالمات إلى خدمة البحث باستخدام مفاتيح واجهة برمجة التطبيقات للمصادقة. لا يمكن تعيين هذا إلى صحيح إذا تم تعريف "dataPlaneAuthOptions".
encryptionWithCmk	يحدد أي نهج يتعلق بتشفير الموارد (مثل الفهارس) باستخدام مفاتيح مدير العملاء داخل خدمة البحث.
hostingMode	ينطبق فقط على وحدة SKU القياسية3. يمكنك تعيين هذه الخاصية لتمكين ما يصل إلى 3 أقسام عالية الكثافة تسمح بما يصل إلى 1000 فهارس، وهو أعلى بكثير من الحد الأقصى للفهرس المسموح بها لأي SKU أخرى. بالنسبة ل standard3 SKU، تكون القيمة إما "افتراضية" أو "highDensity". بالنسبة لجميع وحدات SKU الأخرى، يجب أن تكون هذه القيمة "افتراضية".
identity	هوية المورد.
location	الموقع الجغرافي للمورد. يجب أن يكون هذا أحد مناطق Azure الجغرافية المدعومة والمسجلة (على سبيل المثال، غرب الولايات المتحدة وشرق الولايات المتحدة وجنوب شرق آسيا وما إلى ذلك). هذه الخاصية مطلوبة عند إنشاء مورد جديد.
networkRuleSet	القواعد الخاصة بالشبكة التي تحدد كيفية الوصول إلى خدمة البحث Azure المعرفية.
partitionCount	عدد الأقسام في خدمة البحث؛ إذا تم تحديده، يمكن أن يكون 1 أو 2 أو 3 أو 4 أو 6 أو 12. القيم الأكبر من 1 صالحة فقط لوحدات SKU القياسية. بالنسبة للخدمات "القياسية3" مع تعيين hostingMode إلى "highDensity"، تتراوح القيم المسموح بها بين 1 و3.
privateEndpointConnections	قائمة اتصالات نقطة النهاية الخاصة ب Azure Cognitive خدمة البحث. ملاحظة: لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.
provisioningState	حالة عملية التوفير الأخيرة التي تم إجراؤها على خدمة البحث. التوفير هو حالة وسيطة تحدث أثناء إنشاء سعة الخدمة. بعد إعداد السعة، تتغير provisioningState إما إلى "succeeded" أو "failed". يمكن لتطبيقات العميل التحقق من حالة التوفير (الفاصل الزمني للاستقصاء الموصى به هو من 30 ثانية إلى دقيقة واحدة) باستخدام عملية الحصول على خدمة البحث لمعرفة وقت اكتمال العملية. إذا كنت تستخدم الخدمة المجانية، فإن هذه القيمة تميل إلى العودة على أنها "نجحت" مباشرة في استدعاء إنشاء خدمة بحث. وذلك لأن الخدمة المجانية تستخدم السعة التي تم إعدادها بالفعل. ملاحظة: لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.
publicNetworkAccess	يمكن تعيين هذه القيمة إلى "ممكن" لتجنب كسر التغييرات على موارد العملاء والقوالب الموجودة. إذا تم تعيينها إلى "معطل"، فلن يسمح بنسبة استخدام الشبكة عبر الواجهة العامة، وستكون اتصالات نقطة النهاية الخاصة هي أسلوب الوصول الحصري.
replicaCount	عدد النسخ المتماثلة في خدمة البحث. إذا تم تحديدها، يجب أن تكون قيمة بين 1 و12 شاملة لوحدات SKU القياسية أو بين 1 و3 شاملة ل SKU الأساسية.
semanticSearch	تعيين الخيارات التي تتحكم في توفر البحث الدلالي. هذا التكوين ممكن فقط لبعض وحدات SKU الخاصة ب Azure Cognitive Search في مواقع معينة.
sharedPrivateLinkResources	قائمة موارد الارتباط الخاص المشتركة التي تديرها خدمة البحث Azure المعرفية. ملاحظة: لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.
sku	SKU لخدمة البحث، والتي تحدد مستوى السعر وحدود السعة. هذه الخاصية مطلوبة عند إنشاء خدمة بحث جديدة.
status	حالة خدمة البحث. تتضمن القيم المحتملة: "قيد التشغيل": خدمة البحث قيد التشغيل ولا توجد عمليات تزويد جارية. "التوفير": يتم توفير خدمة البحث أو توسيع نطاقها لأعلى أو لأسفل. "الحذف": يتم حذف خدمة البحث. "متدهور": خدمة البحث متدهورة. يمكن أن يحدث هذا عندما لا تكون وحدات البحث الأساسية سليمة. من المرجح أن تكون خدمة البحث تشغيلية، ولكن قد يكون الأداء بطيئا وقد يتم إسقاط بعض الطلبات. "معطل": تم تعطيل خدمة البحث. في هذه الحالة، سترفض الخدمة جميع طلبات واجهة برمجة التطبيقات. "خطأ": خدمة البحث في حالة خطأ. إذا كانت خدمتك في حالات تدهور أو تعطيل أو خطأ، فهذا يعني أن فريق Azure Cognitive Search يحقق بنشاط في المشكلة الأساسية. لا تزال الخدمات المخصصة في هذه الحالات قابلة للرسوم بناء على عدد وحدات البحث المقدمة. ملاحظة: لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.
statusDetails	تفاصيل حالة خدمة البحث. ملاحظة: لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.
tags	علامات للمساعدة في تصنيف المورد في مدخل Microsoft Azure.

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

id	معرف المورد المؤهل بالكامل للمورد. مثال - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ملاحظة: لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.
name	اسم المورد NOTE: لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.
type	نوع المورد. على سبيل المثال، ملاحظة "Microsoft.Compute/virtualMachines" أو "Microsoft.Storage/storageAccounts": لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.

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

authOptions

يحدد خيارات كيفية مصادقة واجهة برمجة تطبيقات مستوى البيانات لخدمة البحث للطلبات. لا يمكن تعيين هذا إذا تم تعيين "disableLocalAuth" إلى true.

authOptions?: DataPlaneAuthOptions

قيمة الخاصية

DataPlaneAuthOptions

disableLocalAuth

عند التعيين إلى صحيح، لن يسمح للمكالمات إلى خدمة البحث باستخدام مفاتيح واجهة برمجة التطبيقات للمصادقة. لا يمكن تعيين هذا إلى صحيح إذا تم تعريف "dataPlaneAuthOptions".

disableLocalAuth?: boolean

قيمة الخاصية

boolean

encryptionWithCmk

يحدد أي نهج يتعلق بتشفير الموارد (مثل الفهارس) باستخدام مفاتيح مدير العملاء داخل خدمة البحث.

encryptionWithCmk?: EncryptionWithCmk

قيمة الخاصية

EncryptionWithCmk

hostingMode

ينطبق فقط على وحدة SKU القياسية3. يمكنك تعيين هذه الخاصية لتمكين ما يصل إلى 3 أقسام عالية الكثافة تسمح بما يصل إلى 1000 فهارس، وهو أعلى بكثير من الحد الأقصى للفهرس المسموح بها لأي SKU أخرى. بالنسبة ل standard3 SKU، تكون القيمة إما "افتراضية" أو "highDensity". بالنسبة لجميع وحدات SKU الأخرى، يجب أن تكون هذه القيمة "افتراضية".

hostingMode?: HostingMode

قيمة الخاصية

HostingMode

identity

هوية المورد.

identity?: Identity

قيمة الخاصية

Identity

location

الموقع الجغرافي للمورد. يجب أن يكون هذا أحد مناطق Azure الجغرافية المدعومة والمسجلة (على سبيل المثال، غرب الولايات المتحدة وشرق الولايات المتحدة وجنوب شرق آسيا وما إلى ذلك). هذه الخاصية مطلوبة عند إنشاء مورد جديد.

location?: string

قيمة الخاصية

string

networkRuleSet

القواعد الخاصة بالشبكة التي تحدد كيفية الوصول إلى خدمة البحث Azure المعرفية.

networkRuleSet?: NetworkRuleSet

قيمة الخاصية

NetworkRuleSet

partitionCount

عدد الأقسام في خدمة البحث؛ إذا تم تحديده، يمكن أن يكون 1 أو 2 أو 3 أو 4 أو 6 أو 12. القيم الأكبر من 1 صالحة فقط لوحدات SKU القياسية. بالنسبة للخدمات "القياسية3" مع تعيين hostingMode إلى "highDensity"، تتراوح القيم المسموح بها بين 1 و3.

partitionCount?: number

قيمة الخاصية

number

privateEndpointConnections

قائمة اتصالات نقطة النهاية الخاصة ب Azure Cognitive خدمة البحث. ملاحظة: لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.

privateEndpointConnections?: PrivateEndpointConnection[]

قيمة الخاصية

PrivateEndpointConnection[]

provisioningState

حالة عملية التوفير الأخيرة التي تم إجراؤها على خدمة البحث. التوفير هو حالة وسيطة تحدث أثناء إنشاء سعة الخدمة. بعد إعداد السعة، تتغير provisioningState إما إلى "succeeded" أو "failed". يمكن لتطبيقات العميل التحقق من حالة التوفير (الفاصل الزمني للاستقصاء الموصى به هو من 30 ثانية إلى دقيقة واحدة) باستخدام عملية الحصول على خدمة البحث لمعرفة وقت اكتمال العملية. إذا كنت تستخدم الخدمة المجانية، فإن هذه القيمة تميل إلى العودة على أنها "نجحت" مباشرة في استدعاء إنشاء خدمة بحث. وذلك لأن الخدمة المجانية تستخدم السعة التي تم إعدادها بالفعل. ملاحظة: لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.

provisioningState?: ProvisioningState

قيمة الخاصية

ProvisioningState

publicNetworkAccess

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

publicNetworkAccess?: PublicNetworkAccess

قيمة الخاصية

PublicNetworkAccess

replicaCount

عدد النسخ المتماثلة في خدمة البحث. إذا تم تحديدها، يجب أن تكون قيمة بين 1 و12 شاملة لوحدات SKU القياسية أو بين 1 و3 شاملة ل SKU الأساسية.

replicaCount?: number

قيمة الخاصية

number

semanticSearch

تعيين الخيارات التي تتحكم في توفر البحث الدلالي. هذا التكوين ممكن فقط لبعض وحدات SKU الخاصة ب Azure Cognitive Search في مواقع معينة.

semanticSearch?: string

قيمة الخاصية

string

sharedPrivateLinkResources

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

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

قيمة الخاصية

SharedPrivateLinkResource[]

sku

SKU لخدمة البحث، والتي تحدد مستوى السعر وحدود السعة. هذه الخاصية مطلوبة عند إنشاء خدمة بحث جديدة.

sku?: Sku

قيمة الخاصية

Sku

status

حالة خدمة البحث. تتضمن القيم المحتملة: "قيد التشغيل": خدمة البحث قيد التشغيل ولا توجد عمليات تزويد جارية. "التوفير": يتم توفير خدمة البحث أو توسيع نطاقها لأعلى أو لأسفل. "الحذف": يتم حذف خدمة البحث. "متدهور": خدمة البحث متدهورة. يمكن أن يحدث هذا عندما لا تكون وحدات البحث الأساسية سليمة. من المرجح أن تكون خدمة البحث تشغيلية، ولكن قد يكون الأداء بطيئا وقد يتم إسقاط بعض الطلبات. "معطل": تم تعطيل خدمة البحث. في هذه الحالة، سترفض الخدمة جميع طلبات واجهة برمجة التطبيقات. "خطأ": خدمة البحث في حالة خطأ. إذا كانت خدمتك في حالات تدهور أو تعطيل أو خطأ، فهذا يعني أن فريق Azure Cognitive Search يحقق بنشاط في المشكلة الأساسية. لا تزال الخدمات المخصصة في هذه الحالات قابلة للرسوم بناء على عدد وحدات البحث المقدمة. ملاحظة: لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.

status?: SearchServiceStatus

قيمة الخاصية

SearchServiceStatus

statusDetails

تفاصيل حالة خدمة البحث. ملاحظة: لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.

statusDetails?: string

قيمة الخاصية

string

tags

علامات للمساعدة في تصنيف المورد في مدخل Microsoft Azure.

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

قيمة الخاصية

{[propertyName: string]: string}

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

id

معرف المورد المؤهل بالكامل للمورد. مثال - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ملاحظة: لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.

id?: string

قيمة الخاصية

string

موروث منResource.id

name

اسم المورد NOTE: لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.

name?: string

قيمة الخاصية

string

موروث منResource.name

type

نوع المورد. على سبيل المثال، ملاحظة "Microsoft.Compute/virtualMachines" أو "Microsoft.Storage/storageAccounts": لن يتم تسلسل هذه الخاصية. يمكن ملؤه فقط بواسطة الخادم.

type?: string

قيمة الخاصية

string

موروث منResource.type