@azure/arm-search package

الفصول

SearchManagementClient

الواجهات

AdminKeyResult

الاستجابة التي تحتوي على مفاتيح واجهة برمجة تطبيقات المسؤول الأساسية والثانوية خدمة البحث Azure المعرفية المحددة.

AdminKeys

واجهة تمثل AdminKeys.

AdminKeysGetOptionalParams

المعلمات الاختيارية.

AdminKeysRegenerateOptionalParams

المعلمات الاختيارية.

AsyncOperationResult

تفاصيل عملية مورد الارتباط الخاص المشتركة غير المتزامنة طويلة الأمد

CheckNameAvailabilityInput

إدخال واجهة برمجة تطبيقات التحقق من توفر الاسم.

CheckNameAvailabilityOutput

إخراج التحقق من واجهة برمجة تطبيقات توفر الاسم.

CloudError

يحتوي على معلومات حول خطأ واجهة برمجة التطبيقات.

CloudErrorBody

يصف خطأ واجهة برمجة تطبيقات معينا برمز خطأ ورسالة.

DataPlaneAadOrApiKeyAuthOption

يشير إلى أنه يمكن استخدام مفتاح واجهة برمجة التطبيقات أو رمز مميز للوصول من Azure Active Directory للمصادقة.

DataPlaneAuthOptions

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

EncryptionWithCmk

يصف النهج الذي يحدد كيفية تشفير الموارد داخل خدمة البحث باستخدام المفاتيح المدارة من قبل العميل.

Identity

هوية المورد.

IpRule

قاعدة تقييد IP ل Azure Cognitive خدمة البحث.

ListQueryKeysResult

الاستجابة التي تحتوي على مفاتيح واجهة برمجة تطبيقات الاستعلام خدمة البحث Azure المعرفية المحددة.

NetworkRuleSet

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

Operation

يصف عملية واجهة برمجة تطبيقات REST.

OperationDisplay

الكائن الذي يصف العملية.

OperationListResult

نتيجة طلب سرد عمليات واجهة برمجة تطبيقات REST. يحتوي على قائمة العمليات وعنوان URL للحصول على المجموعة التالية من النتائج.

Operations

واجهة تمثل عمليات.

OperationsListOptionalParams

المعلمات الاختيارية.

PrivateEndpointConnection

توضح هذه المقالة اتصال نقطة نهاية خاصة موجود ب Azure Cognitive خدمة البحث.

PrivateEndpointConnectionListResult

الاستجابة التي تحتوي على قائمة باتصالات نقطة النهاية الخاصة.

PrivateEndpointConnectionProperties

يصف خصائص اتصال نقطة النهاية الخاصة الحالي ب Azure Cognitive خدمة البحث.

PrivateEndpointConnectionPropertiesPrivateEndpoint

مورد نقطة النهاية الخاصة من موفر Microsoft.Network.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

يصف الحالة الحالية لاتصال خدمة Private Link موجود بنقطة نهاية Azure الخاصة.

PrivateEndpointConnections

واجهة تمثل PrivateEndpointConnections.

PrivateEndpointConnectionsDeleteOptionalParams

المعلمات الاختيارية.

PrivateEndpointConnectionsGetOptionalParams

المعلمات الاختيارية.

PrivateEndpointConnectionsListByServiceNextOptionalParams

المعلمات الاختيارية.

PrivateEndpointConnectionsListByServiceOptionalParams

المعلمات الاختيارية.

PrivateEndpointConnectionsUpdateOptionalParams

المعلمات الاختيارية.

PrivateLinkResource

يصف مورد ارتباط خاص مدعوم ل Azure Cognitive خدمة البحث.

PrivateLinkResourceProperties

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

PrivateLinkResources

واجهة تمثل PrivateLinkResources.

PrivateLinkResourcesListSupportedOptionalParams

المعلمات الاختيارية.

PrivateLinkResourcesResult

الاستجابة التي تحتوي على قائمة بموارد الارتباط الخاص المدعومة.

QueryKey

يصف مفتاح واجهة برمجة التطبيقات ل Azure Cognitive خدمة البحث معين لديه أذونات لعمليات الاستعلام فقط.

QueryKeys

واجهة تمثل QueryKeys.

QueryKeysCreateOptionalParams

المعلمات الاختيارية.

QueryKeysDeleteOptionalParams

المعلمات الاختيارية.

QueryKeysListBySearchServiceNextOptionalParams

المعلمات الاختيارية.

QueryKeysListBySearchServiceOptionalParams

المعلمات الاختيارية.

QuotaUsageResult

يصف استخدام الحصة النسبية لوحدة sku معينة مدعومة من Azure Cognitive Search.

QuotaUsageResultName

اسم sku الذي يدعمه Azure Cognitive Search.

QuotaUsagesListResult

الاستجابة التي تحتوي على معلومات استخدام الحصة النسبية لجميع وحدات sku المدعومة من Azure Cognitive خدمة البحث.

Resource

الحقول الشائعة التي يتم إرجاعها في الاستجابة لجميع موارد Azure Resource Manager

SearchManagementClientOptionalParams

المعلمات الاختيارية.

SearchManagementRequestOptions

مجموعة المعلمات

SearchService

يصف Azure Cognitive خدمة البحث وحالته الحالية.

SearchServiceListResult

الاستجابة التي تحتوي على قائمة بخدمات Azure Cognitive Search.

SearchServiceUpdate

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

Services

واجهة تمثل خدمات.

ServicesCheckNameAvailabilityOptionalParams

المعلمات الاختيارية.

ServicesCreateOrUpdateOptionalParams

المعلمات الاختيارية.

ServicesDeleteOptionalParams

المعلمات الاختيارية.

ServicesGetOptionalParams

المعلمات الاختيارية.

ServicesListByResourceGroupNextOptionalParams

المعلمات الاختيارية.

ServicesListByResourceGroupOptionalParams

المعلمات الاختيارية.

ServicesListBySubscriptionNextOptionalParams

المعلمات الاختيارية.

ServicesListBySubscriptionOptionalParams

المعلمات الاختيارية.

ServicesUpdateOptionalParams

المعلمات الاختيارية.

ShareablePrivateLinkResourceProperties

يصف خصائص نوع المورد الذي تم إلحاقه بخدمة الارتباط الخاص، التي يدعمها Azure Cognitive Search.

ShareablePrivateLinkResourceType

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

SharedPrivateLinkResource

يصف مورد ارتباط خاص مشترك يديره Azure Cognitive خدمة البحث.

SharedPrivateLinkResourceListResult

الاستجابة التي تحتوي على قائمة بموارد الارتباط الخاص المشترك.

SharedPrivateLinkResourceProperties

يصف خصائص مورد ارتباط خاص مشترك موجود تديره Azure Cognitive خدمة البحث.

SharedPrivateLinkResources

واجهة تمثل SharedPrivateLinkResources.

SharedPrivateLinkResourcesCreateOrUpdateOptionalParams

المعلمات الاختيارية.

SharedPrivateLinkResourcesDeleteOptionalParams

المعلمات الاختيارية.

SharedPrivateLinkResourcesGetOptionalParams

المعلمات الاختيارية.

SharedPrivateLinkResourcesListByServiceNextOptionalParams

المعلمات الاختيارية.

SharedPrivateLinkResourcesListByServiceOptionalParams

المعلمات الاختيارية.

Sku

يحدد SKU لخدمة Azure Cognitive Search Service، والتي تحدد مستوى السعر وحدود السعة.

TrackedResource

تعريف نموذج المورد لمورد Azure Resource Manager تعقب المستوى الأعلى الذي يحتوي على "علامات" و"موقع"

UsageBySubscriptionSkuOptionalParams

المعلمات الاختيارية.

Usages

واجهة تمثل استخدامات.

UsagesListBySubscriptionNextOptionalParams

المعلمات الاختيارية.

UsagesListBySubscriptionOptionalParams

المعلمات الاختيارية.

النوع أسماء مستعارة

AadAuthFailureMode

يحدد قيم AadAuthFailureMode.

AdminKeyKind

يحدد قيم AdminKeyKind.

AdminKeysGetResponse

يحتوي على بيانات الاستجابة لعملية الحصول.

AdminKeysRegenerateResponse

يحتوي على بيانات الاستجابة لعملية إعادة التجديد.

HostingMode

يحدد قيم HostingMode.

IdentityType

يحدد قيم IdentityType.

OperationsListResponse

يحتوي على بيانات الاستجابة لعملية القائمة.

PrivateEndpointConnectionsDeleteResponse

يحتوي على بيانات الاستجابة لعملية الحذف.

PrivateEndpointConnectionsGetResponse

يحتوي على بيانات الاستجابة لعملية الحصول.

PrivateEndpointConnectionsListByServiceNextResponse

يحتوي على بيانات الاستجابة لعملية listByServiceNext.

PrivateEndpointConnectionsListByServiceResponse

يحتوي على بيانات الاستجابة لعملية listByService.

PrivateEndpointConnectionsUpdateResponse

يحتوي على بيانات الاستجابة لعملية التحديث.

PrivateLinkResourcesListSupportedResponse

يحتوي على بيانات الاستجابة لعملية listSupported.

PrivateLinkServiceConnectionProvisioningState

يحدد قيم PrivateLinkServiceConnectionProvisioningState.
يمكن استخدام KnownPrivateLinkServiceConnectionProvisioningState بالتبادل مع PrivateLinkServiceConnectionProvisioningState، ويحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

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

PrivateLinkServiceConnectionStatus

يحدد قيم PrivateLinkServiceConnectionStatus.

ProvisioningState

يحدد قيم ProvisioningState.

PublicNetworkAccess

يحدد قيم PublicNetworkAccess.

QueryKeysCreateResponse

يحتوي على بيانات الاستجابة لعملية الإنشاء.

QueryKeysListBySearchServiceNextResponse

يحتوي على بيانات الاستجابة لعملية listBySearchServiceNext.

QueryKeysListBySearchServiceResponse

يحتوي على بيانات الاستجابة لعملية listBySearchService.

SearchEncryptionComplianceStatus

يحدد قيم SearchEncryptionComplianceStatus.

SearchEncryptionWithCmk

يحدد قيم SearchEncryptionWithCmk.

SearchSemanticSearch

يحدد قيم SearchSemanticSearch.
يمكن استخدام KnownSearchSemanticSearch بالتبادل مع SearchSemanticSearch، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

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

SearchServiceStatus

يحدد قيم SearchServiceStatus.

ServicesCheckNameAvailabilityResponse

يحتوي على بيانات الاستجابة لعملية checkNameAvailability.

ServicesCreateOrUpdateResponse

يحتوي على بيانات الاستجابة لعملية createOrUpdate.

ServicesGetResponse

يحتوي على بيانات الاستجابة لعملية الحصول.

ServicesListByResourceGroupNextResponse

يحتوي على بيانات الاستجابة لعملية listByResourceGroupNext.

ServicesListByResourceGroupResponse

يحتوي على بيانات الاستجابة لعملية listByResourceGroup.

ServicesListBySubscriptionNextResponse

يحتوي على بيانات الاستجابة لعملية listBySubscriptionNext.

ServicesListBySubscriptionResponse

يحتوي على بيانات الاستجابة لعملية listBySubscription.

ServicesUpdateResponse

يحتوي على بيانات الاستجابة لعملية التحديث.

SharedPrivateLinkResourceAsyncOperationResult

يحدد قيم SharedPrivateLinkResourceAsyncOperationResult.
يمكن استخدام KnownSharedPrivateLinkResourceAsyncOperationResult بالتبادل مع SharedPrivateLinkResourceAsyncOperationResult، ويحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

قيد التشغيل
Succeeded
فشل

SharedPrivateLinkResourceProvisioningState

يحدد قيم SharedPrivateLinkResourceProvisioningState.

SharedPrivateLinkResourceStatus

يحدد قيم SharedPrivateLinkResourceStatus.

SharedPrivateLinkResourcesCreateOrUpdateResponse

يحتوي على بيانات الاستجابة لعملية createOrUpdate.

SharedPrivateLinkResourcesGetResponse

يحتوي على بيانات الاستجابة لعملية الحصول.

SharedPrivateLinkResourcesListByServiceNextResponse

يحتوي على بيانات الاستجابة لعملية listByServiceNext.

SharedPrivateLinkResourcesListByServiceResponse

يحتوي على بيانات الاستجابة لعملية listByService.

SkuName

يحدد قيم SkuName.

UnavailableNameReason

يحدد قيم UnavailableNameReason.
يمكن استخدام KnownUnavailableNameReason بالتبادل مع UnavailableNameReason، ويحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

غير صحيح: اسم خدمة البحث لا يتطابق مع متطلبات التسمية.
AlreadyExists: تم تعيين اسم خدمة البحث بالفعل إلى خدمة بحث مختلفة.

UsageBySubscriptionSkuResponse

يحتوي على بيانات الاستجابة لعملية usageBySubscriptionSku.

UsagesListBySubscriptionNextResponse

يحتوي على بيانات الاستجابة لعملية listBySubscriptionNext.

UsagesListBySubscriptionResponse

يحتوي على بيانات الاستجابة لعملية listBySubscription.

التعدادات

KnownPrivateLinkServiceConnectionProvisioningState

القيم المعروفة ل PrivateLinkServiceConnectionProvisioningState التي تقبلها الخدمة.

KnownSearchSemanticSearch

القيم المعروفة ل SearchSemanticSearch التي تقبلها الخدمة.

KnownSharedPrivateLinkResourceAsyncOperationResult

القيم المعروفة ل SharedPrivateLinkResourceAsyncOperationResult التي تقبلها الخدمة.

KnownUnavailableNameReason

القيم المعروفة ل UnavailableNameReason التي تقبلها الخدمة.

الوظائف

getContinuationToken(unknown)

نظرا لآخر .value منتج من قبل byPage المكرر، يقوم بإرجاع رمز استمرار يمكن استخدامه لبدء الترحيل من تلك النقطة لاحقا.

تفاصيل الوظيفة

getContinuationToken(unknown)

نظرا لآخر .value منتج من قبل byPage المكرر، يقوم بإرجاع رمز استمرار يمكن استخدامه لبدء الترحيل من تلك النقطة لاحقا.

function getContinuationToken(page: unknown): string | undefined

المعلمات

page

unknown

كائن من الوصول إلى value IteratorResult من byPage مكرر.

المرتجعات

string | undefined

رمز المتابعة المميز الذي يمكن تمريره إلى byPage() أثناء المكالمات المستقبلية.