ServiceClientOptions interface
الخيارات التي سيتم توفيرها أثناء إنشاء العميل.
- Extends
الخصائص
| base |
إذا تم تحديده، فهذا هو عنوان URI الأساسي الذي سيتم إجراء الطلبات مقابله ل ServiceClient هذا. إذا لم يتم تحديده، فيجب أن تحتوي جميع OperationSpecs على خاصية baseUrl. |
| credential | بيانات الاعتماد المستخدمة لمصادقة الطلب. |
| credential |
إذا تم تحديده، فسيتم استخدامه لإنشاء BearerTokenAuthenticationPolicy. |
| endpoint | إذا تم تحديدها، فهذه هي نقطة النهاية التي سيتم إجراء الطلبات مقابلها ل ServiceClient هذا. إذا لم يتم تحديده، فيجب أن تحتوي جميع OperationSpecs على خاصية baseUrl. لتشجيع العميل على استخدام نقطة النهاية، نضع علامة على baseUri على أنه مهمل. |
| pipeline | البنية الأساسية لبرنامج ربط العمليات التجارية المخصصة لاستخدامها، وإلا سيتم إنشاء مسار افتراضي. |
| request |
نوع محتوى الطلب الافتراضي للخدمة. يستخدم إذا لم يكن requestContentType موجودا على OperationSpec. |
الخصائص الموروثة
| additional |
نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP. |
| allow |
تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS |
| http |
HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP. |
| proxy |
خيارات لتكوين وكيل للطلبات الصادرة. |
| redirect |
خيارات لكيفية معالجة استجابات إعادة التوجيه. |
| retry |
الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة. |
| telemetry |
خيارات لتعيين معلومات القياس عن بعد والتتبع الشائعة للطلبات الصادرة. |
| tls |
خيارات لتكوين مصادقة TLS |
| user |
خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة. |
تفاصيل الخاصية
baseUri
تحذير
واجهة برمجة التطبيقات هذه مهملة الآن.
This property is deprecated and will be removed soon, please use endpoint instead
إذا تم تحديده، فهذا هو عنوان URI الأساسي الذي سيتم إجراء الطلبات مقابله ل ServiceClient هذا. إذا لم يتم تحديده، فيجب أن تحتوي جميع OperationSpecs على خاصية baseUrl.
baseUri?: stringقيمة الخاصية
string
credential
credentialScopes
إذا تم تحديده، فسيتم استخدامه لإنشاء BearerTokenAuthenticationPolicy.
credentialScopes?: string | string[]قيمة الخاصية
string | string[]
endpoint
إذا تم تحديدها، فهذه هي نقطة النهاية التي سيتم إجراء الطلبات مقابلها ل ServiceClient هذا. إذا لم يتم تحديده، فيجب أن تحتوي جميع OperationSpecs على خاصية baseUrl. لتشجيع العميل على استخدام نقطة النهاية، نضع علامة على baseUri على أنه مهمل.
endpoint?: stringقيمة الخاصية
string
pipeline
البنية الأساسية لبرنامج ربط العمليات التجارية المخصصة لاستخدامها، وإلا سيتم إنشاء مسار افتراضي.
pipeline?: Pipelineقيمة الخاصية
requestContentType
نوع محتوى الطلب الافتراضي للخدمة. يستخدم إذا لم يكن requestContentType موجودا على OperationSpec.
requestContentType?: stringقيمة الخاصية
string
تفاصيل الخاصية الموروثة
additionalPolicies
نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
additionalPolicies?: AdditionalPolicyConfig[]قيمة الخاصية
allowInsecureConnection
تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS
allowInsecureConnection?: booleanقيمة الخاصية
boolean
httpClient
HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP.
httpClient?: HttpClientقيمة الخاصية
موروث منCommonClientOptions.httpClient
proxyOptions
خيارات لتكوين وكيل للطلبات الصادرة.
proxyOptions?: ProxySettingsقيمة الخاصية
موروث منCommonClientOptions.proxyOptions
redirectOptions
خيارات لكيفية معالجة استجابات إعادة التوجيه.
redirectOptions?: RedirectPolicyOptionsقيمة الخاصية
retryOptions
الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.
retryOptions?: PipelineRetryOptionsقيمة الخاصية
موروث منCommonClientOptions.retryOptions
telemetryOptions
خيارات لتعيين معلومات القياس عن بعد والتتبع الشائعة للطلبات الصادرة.
telemetryOptions?: TelemetryOptionsقيمة الخاصية
tlsOptions
خيارات لتكوين مصادقة TLS
tlsOptions?: TlsSettingsقيمة الخاصية
موروث منCommonClientOptions.tlsOptions
userAgentOptions
خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.
userAgentOptions?: UserAgentPolicyOptions