ServiceClientOptions interface

الحزمة:

@azure/ms-rest-js

الخيارات التي سيتم توفيرها أثناء إنشاء العميل.

الخصائص

agentSettings	عوامل HTTP وHTTPS التي سيتم استخدامها لكل طلب HTTP (Node.js فقط).
baseUri	إذا تم تحديده: يصبح هذا baseUri URI الأساسي الذي سيتم إجراء الطلبات مقابله ل ServiceClient هذا. إذا تطابق baseUri مع نقطة نهاية معروفة لإدارة الموارد وإذا تم تمرير TokenCredential من خلال الدالة الإنشائية، فإن هذا baseUri يحدد نطاق getToken الذي سيتم ${options.baseUri}/.default. وإلا، فإن النطاق افتراضيا إلى "https://management.azure.com/.default". إذا لم يتم تحديده: يجب أن تحتوي كافة OperationSpecs على خاصية baseUrl. إذا تم تمرير TokenCredential من خلال الدالة الإنشائية، يتم تعيين نطاق getToken ليكون "https://management.azure.com/.default".
clientRequestIdHeaderName	إذا تم تحديده، ستتم إضافة GenerateRequestIdPolicy إلى مسار HTTP الذي سيضيف عنوانا إلى جميع الطلبات الصادرة باسم العنوان هذا و UUID عشوائي كمعرف الطلب.
deserializationContentTypes	أنواع المحتوى التي سيتم إقرانها بتسلسل JSON أو XML.
generateClientRequestIdHeader	ما إذا كان يجب إنشاء عنوان معرف طلب عميل لكل طلب HTTP أم لا.
httpClient	HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP.
httpPipelineLogger	HttpPipelineLogger الذي يمكن استخدامه لتصحيح RequestPolicies داخل البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
noRetryPolicy	إذا تم التعيين إلى صحيح، فقم بإيقاف تشغيل نهج إعادة المحاولة الافتراضي.
proxySettings	إعدادات الوكيل التي سيتم استخدامها لكل طلب HTTP (Node.js فقط).
redirectOptions	خيارات لكيفية معالجة استجابات إعادة التوجيه.
requestPolicyFactories	صفيف من المصانع التي يتم استدعاؤها لإنشاء مسار RequestPolicy المستخدم لإرسال طلب HTTP على السلك، أو دالة تأخذ في defaultRequestPolicyFactories وتعيد requestPolicyFactories التي سيتم استخدامها.
rpRegistrationRetryTimeout	الحصول على مهلة إعادة المحاولة أو تعيينها في ثوان ل AutomaticRPRegistration. القيمة الافتراضية هي 30.
userAgent	السلسلة التي سيتم تعيينها إلى عنوان بيانات تتبع الاستخدام أثناء إرسال الطلب، أو دالة تأخذ في سلسلة عامل المستخدم الافتراضية وترجع سلسلة عامل المستخدم التي سيتم استخدامها.
userAgentHeaderName	اسم العنوان الذي يجب استخدامه لعنوان بيانات تتبع الاستخدام أثناء إرسال الطلب. إذا لم يتم تحديد هذا، استخدام "عامل المستخدم" عند التشغيل على Node.js وسيتم استخدام "x-ms-command-name" عند التشغيل في مستعرض.
withCredentials	ما إذا كان يجب تضمين بيانات الاعتماد في طلبات CORS في المستعرض. راجع https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials لمزيد من المعلومات.

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

agentSettings

عوامل HTTP وHTTPS التي سيتم استخدامها لكل طلب HTTP (Node.js فقط).

agentSettings?: AgentSettings

قيمة الخاصية

AgentSettings

baseUri

إذا تم تحديده:

• يصبح هذا baseUri URI الأساسي الذي سيتم إجراء الطلبات مقابله ل ServiceClient هذا.
• إذا تطابق baseUri مع نقطة نهاية معروفة لإدارة الموارد وإذا تم تمرير TokenCredential من خلال الدالة الإنشائية، فإن هذا baseUri يحدد نطاق getToken الذي سيتم ${options.baseUri}/.default. وإلا، فإن النطاق افتراضيا إلى "https://management.azure.com/.default".

إذا لم يتم تحديده:

• يجب أن تحتوي كافة OperationSpecs على خاصية baseUrl.
• إذا تم تمرير TokenCredential من خلال الدالة الإنشائية، يتم تعيين نطاق getToken ليكون "https://management.azure.com/.default".

baseUri?: string

قيمة الخاصية

string

clientRequestIdHeaderName

إذا تم تحديده، ستتم إضافة GenerateRequestIdPolicy إلى مسار HTTP الذي سيضيف عنوانا إلى جميع الطلبات الصادرة باسم العنوان هذا و UUID عشوائي كمعرف الطلب.

clientRequestIdHeaderName?: string

قيمة الخاصية

string

deserializationContentTypes

أنواع المحتوى التي سيتم إقرانها بتسلسل JSON أو XML.

deserializationContentTypes?: DeserializationContentTypes

قيمة الخاصية

DeserializationContentTypes

generateClientRequestIdHeader

ما إذا كان يجب إنشاء عنوان معرف طلب عميل لكل طلب HTTP أم لا.

generateClientRequestIdHeader?: boolean

قيمة الخاصية

boolean

httpClient

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

httpClient?: HttpClient

قيمة الخاصية

HttpClient

httpPipelineLogger

HttpPipelineLogger الذي يمكن استخدامه لتصحيح RequestPolicies داخل البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

httpPipelineLogger?: HttpPipelineLogger

قيمة الخاصية

HttpPipelineLogger

noRetryPolicy

إذا تم التعيين إلى صحيح، فقم بإيقاف تشغيل نهج إعادة المحاولة الافتراضي.

noRetryPolicy?: boolean

قيمة الخاصية

boolean

proxySettings

إعدادات الوكيل التي سيتم استخدامها لكل طلب HTTP (Node.js فقط).

proxySettings?: ProxySettings

قيمة الخاصية

ProxySettings

redirectOptions

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

redirectOptions?: RedirectOptions

قيمة الخاصية

RedirectOptions

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-command-name" عند التشغيل في مستعرض.

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