ServiceClientOptions interface
الخيارات التي سيتم توفيرها أثناء إنشاء العميل.
الخصائص
| client |
إذا تم تحديده، ستتم إضافة GenerateRequestIdPolicy إلى مسار HTTP الذي سيضيف عنوانا إلى جميع الطلبات الصادرة باسم العنوان هذا و UUID عشوائي كمعرف الطلب. |
| credential |
إذا تم تحديده، سيتم استخدامه لإنشاء BearerTokenAuthenticationPolicy. |
| deserialization |
أنواع المحتوى التي سيتم إقرانها بتسلسل JSON أو XML. |
| generate |
ما إذا كان يجب إنشاء عنوان معرف طلب عميل لكل طلب HTTP أم لا. |
| http |
HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP. |
| http |
HttpPipelineLogger الذي يمكن استخدامه لتصحيح RequestPolicies داخل البنية الأساسية لبرنامج ربط العمليات التجارية HTTP. |
| no |
إذا تم التعيين إلى صحيح، فقم بإيقاف تشغيل نهج إعادة المحاولة الافتراضي. |
| proxy |
إعدادات الوكيل التي سيتم استخدامها لكل طلب HTTP (Node.js فقط). |
| request |
صفيف من المصانع التي يتم استدعاؤها لإنشاء مسار RequestPolicy المستخدم لإرسال طلب HTTP على السلك، أو دالة تأخذ في defaultRequestPolicyFactories وتعيد requestPolicyFactories التي سيتم استخدامها. |
| rp |
الحصول على مهلة إعادة المحاولة أو تعيينها في ثوان ل AutomaticRPRegistration. القيمة الافتراضية هي 30. |
| user |
السلسلة التي سيتم تعيينها إلى عنوان بيانات تتبع الاستخدام أثناء إرسال الطلب، أو دالة تأخذ في سلسلة عامل المستخدم الافتراضية وترجع سلسلة عامل المستخدم التي سيتم استخدامها. |
| user |
اسم العنوان الذي يجب استخدامه لعنوان بيانات تتبع الاستخدام أثناء إرسال الطلب. إذا لم يتم تحديد ذلك، استخدام "عامل المستخدم" عند التشغيل على Node.js وسيتم استخدام "x-ms-useragent" عند التشغيل في مستعرض. |
| with |
ما إذا كان يجب تضمين بيانات الاعتماد في طلبات CORS في المستعرض. راجع https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials لمزيد من المعلومات. |
تفاصيل الخاصية
clientRequestIdHeaderName
إذا تم تحديده، ستتم إضافة GenerateRequestIdPolicy إلى مسار HTTP الذي سيضيف عنوانا إلى جميع الطلبات الصادرة باسم العنوان هذا و UUID عشوائي كمعرف الطلب.
clientRequestIdHeaderName?: string
قيمة الخاصية
string
credentialScopes
إذا تم تحديده، سيتم استخدامه لإنشاء BearerTokenAuthenticationPolicy.
credentialScopes?: string | string[]
قيمة الخاصية
string | string[]
deserializationContentTypes
أنواع المحتوى التي سيتم إقرانها بتسلسل JSON أو XML.
deserializationContentTypes?: DeserializationContentTypes
قيمة الخاصية
generateClientRequestIdHeader
ما إذا كان يجب إنشاء عنوان معرف طلب عميل لكل طلب HTTP أم لا.
generateClientRequestIdHeader?: boolean
قيمة الخاصية
boolean
httpClient
httpPipelineLogger
HttpPipelineLogger الذي يمكن استخدامه لتصحيح RequestPolicies داخل البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
httpPipelineLogger?: HttpPipelineLogger
قيمة الخاصية
noRetryPolicy
إذا تم التعيين إلى صحيح، فقم بإيقاف تشغيل نهج إعادة المحاولة الافتراضي.
noRetryPolicy?: boolean
قيمة الخاصية
boolean
proxySettings
إعدادات الوكيل التي سيتم استخدامها لكل طلب HTTP (Node.js فقط).
proxySettings?: ProxySettings
قيمة الخاصية
requestPolicyFactories
صفيف من المصانع التي يتم استدعاؤها لإنشاء مسار RequestPolicy المستخدم لإرسال طلب HTTP على السلك، أو دالة تأخذ في defaultRequestPolicyFactories وتعيد requestPolicyFactories التي سيتم استخدامها.
requestPolicyFactories?: RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]
قيمة الخاصية
RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]
rpRegistrationRetryTimeout
الحصول على مهلة إعادة المحاولة أو تعيينها في ثوان ل AutomaticRPRegistration. القيمة الافتراضية هي 30.
rpRegistrationRetryTimeout?: number
قيمة الخاصية
number
userAgent
السلسلة التي سيتم تعيينها إلى عنوان بيانات تتبع الاستخدام أثناء إرسال الطلب، أو دالة تأخذ في سلسلة عامل المستخدم الافتراضية وترجع سلسلة عامل المستخدم التي سيتم استخدامها.
userAgent?: string | (defaultUserAgent: string) => string
قيمة الخاصية
string | (defaultUserAgent: string) => string
userAgentHeaderName
اسم العنوان الذي يجب استخدامه لعنوان بيانات تتبع الاستخدام أثناء إرسال الطلب. إذا لم يتم تحديد ذلك، استخدام "عامل المستخدم" عند التشغيل على Node.js وسيتم استخدام "x-ms-useragent" عند التشغيل في مستعرض.
userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string
قيمة الخاصية
string | (defaultUserAgentHeaderName: string) => string
withCredentials
ما إذا كان يجب تضمين بيانات الاعتماد في طلبات CORS في المستعرض. راجع https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials لمزيد من المعلومات.
withCredentials?: boolean
قيمة الخاصية
boolean