ServiceClientOptions interface
الخيارات التي سيتم توفيرها أثناء إنشاء العميل.
الخصائص
agent |
عوامل HTTP وHTTPS التي سيتم استخدامها لكل طلب HTTP (Node.js فقط). |
base |
إذا تم تحديده:
إذا لم يتم تحديده:
|
client |
إذا تم تحديده، فستتم إضافة GenerateRequestIdPolicy إلى البنية الأساسية لبرنامج ربط العمليات التجارية HTTP التي ستضيف عنوانا إلى جميع الطلبات الصادرة باسم العنوان هذا و UUID عشوائي كمعرف الطلب. |
deserialization |
أنواع المحتوى التي سيتم إقرانها بتسلسل JSON أو XML. |
generate |
ما إذا كان يجب إنشاء عنوان معرف طلب عميل لكل طلب HTTP أم لا. |
http |
HttpClient الذي سيتم استخدامه لإرسال طلبات HTTP. |
http |
HttpPipelineLogger الذي يمكن استخدامه لتصحيح أخطاء RequestPolicies داخل مسار HTTP. |
no |
إذا تم تعيينه إلى true، فقم بإيقاف تشغيل نهج إعادة المحاولة الافتراضي. |
proxy |
إعدادات الوكيل التي سيتم استخدامها لكل طلب HTTP (Node.js فقط). |
redirect |
خيارات لكيفية معالجة استجابات إعادة التوجيه. |
request |
صفيف من المصانع التي يتم استدعاؤها لإنشاء مسار RequestPolicy المستخدم لإرسال طلب HTTP على السلك، أو دالة تأخذ في defaultRequestPolicyFactories وترجع requestPolicyFactories التي سيتم استخدامها. |
rp |
الحصول على مهلة إعادة المحاولة أو تعيينها بالثواني ل AutomaticRPRegistration. القيمة الافتراضية هي:30. |
user |
السلسلة التي سيتم تعيينها إلى عنوان بيانات تتبع الاستخدام أثناء إرسال الطلب، أو دالة تأخذ في سلسلة عامل المستخدم الافتراضية وترجع سلسلة عامل المستخدم التي سيتم استخدامها. |
user |
اسم العنوان المراد استخدامه لعنوان بيانات تتبع الاستخدام أثناء إرسال الطلب. إذا لم يتم تحديد ذلك، فسيتم استخدام "عامل المستخدم" عند التشغيل على Node.js وسيتم استخدام "x-ms-command-name" عند التشغيل في مستعرض. |
with |
ما إذا كان يجب تضمين بيانات الاعتماد في طلبات CORS في المستعرض. راجع https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials لمزيد من المعلومات. |
تفاصيل الخاصية
agentSettings
عوامل HTTP وHTTPS التي سيتم استخدامها لكل طلب HTTP (Node.js فقط).
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
قيمة الخاصية
generateClientRequestIdHeader
ما إذا كان يجب إنشاء عنوان معرف طلب عميل لكل طلب HTTP أم لا.
generateClientRequestIdHeader?: boolean
قيمة الخاصية
boolean
httpClient
httpPipelineLogger
HttpPipelineLogger الذي يمكن استخدامه لتصحيح أخطاء RequestPolicies داخل مسار HTTP.
httpPipelineLogger?: HttpPipelineLogger
قيمة الخاصية
noRetryPolicy
إذا تم تعيينه إلى true، فقم بإيقاف تشغيل نهج إعادة المحاولة الافتراضي.
noRetryPolicy?: boolean
قيمة الخاصية
boolean
proxySettings
إعدادات الوكيل التي سيتم استخدامها لكل طلب HTTP (Node.js فقط).
proxySettings?: ProxySettings
قيمة الخاصية
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