SearchClientOptions interface

الحزمة:

@azure/search-documents

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

Extends

ExtendedCommonClientOptions

الخصائص

apiVersion	إصدار واجهة برمجة التطبيقات لاستخدامه عند الاتصال بالخدمة.
audience	الجمهور الذي يجب استخدامه للمصادقة مع Azure Active Directory (AAD). لا يتم اعتبار الجمهور عند استخدام مفتاح مشترك. يمكن استخدام KnownSearchAudience بالتبادل مع الجمهور
serviceVersion	إصدار الخدمة المراد استخدامه عند الاتصال بالخدمة.

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

additionalPolicies	نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
allowInsecureConnection	تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS
httpClient	HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP.
keepAliveOptions	خيارات لتعطيل البقاء على قيد الحياة.
proxyOptions	خيارات لتكوين وكيل للطلبات الصادرة.
redirectOptions	خيارات لكيفية معالجة استجابات إعادة التوجيه.
retryOptions	الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.
telemetryOptions	خيارات لتعيين معلومات تتبع الاستخدام الشائعة والتتبع للطلبات الصادرة.
tlsOptions	خيارات لتكوين مصادقة TLS
userAgentOptions	خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.

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

apiVersion

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

use serviceVersion instead

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

apiVersion?: string

قيمة الخاصية

string

audience

الجمهور الذي يجب استخدامه للمصادقة مع Azure Active Directory (AAD). لا يتم اعتبار الجمهور عند استخدام مفتاح مشترك. يمكن استخدام KnownSearchAudience بالتبادل مع الجمهور

audience?: string

قيمة الخاصية

string

serviceVersion

إصدار الخدمة المراد استخدامه عند الاتصال بالخدمة.

serviceVersion?: string

قيمة الخاصية

string

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

additionalPolicies

نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

قيمة الخاصية

AdditionalPolicyConfig[]

موروث من ExtendedCommonClientOptions.additionalPolicies

allowInsecureConnection

تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS

allowInsecureConnection?: boolean

قيمة الخاصية

boolean

موروث من ExtendedCommonClientOptions.allowInsecureConnection

httpClient

HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP.

httpClient?: HttpClient

قيمة الخاصية

HttpClient

موروث من ExtendedCommonClientOptions.httpClient

keepAliveOptions

خيارات لتعطيل البقاء على قيد الحياة.

keepAliveOptions?: KeepAliveOptions

قيمة الخاصية

KeepAliveOptions

موروث من ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

خيارات لتكوين وكيل للطلبات الصادرة.

proxyOptions?: ProxySettings

قيمة الخاصية

ProxySettings

موروث من ExtendedCommonClientOptions.proxyOptions

redirectOptions

خيارات لكيفية معالجة استجابات إعادة التوجيه.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

قيمة الخاصية

RedirectPolicyOptions & RedirectOptions

موروث من ExtendedCommonClientOptions.redirectOptions

retryOptions

الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.

retryOptions?: PipelineRetryOptions

قيمة الخاصية

PipelineRetryOptions

موروث من ExtendedCommonClientOptions.retryOptions

telemetryOptions

خيارات لتعيين معلومات تتبع الاستخدام الشائعة والتتبع للطلبات الصادرة.

telemetryOptions?: TelemetryOptions

قيمة الخاصية

TelemetryOptions

موروث من ExtendedCommonClientOptions.telemetryOptions

tlsOptions

خيارات لتكوين مصادقة TLS

tlsOptions?: TlsSettings

قيمة الخاصية

TlsSettings

موروث من ExtendedCommonClientOptions.tlsOptions

userAgentOptions

خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.

userAgentOptions?: UserAgentPolicyOptions

قيمة الخاصية

UserAgentPolicyOptions

موروث من ExtendedCommonClientOptions.userAgentOptions