@azure/core-http package

الفصول

AccessTokenRefresher	يساعد نهج مصادقة الرمز المميز core-http مع طلب رمز مميز جديد إذا لم نكن ننتظر حاليا رمزا مميزا جديدا.
ApiKeyCredentials	المصادقة على خدمة باستخدام مفتاح API.
BaseRequestPolicy	الفئة الأساسية التي تستمد منها كافة نهج الطلب.
BasicAuthenticationCredentials	<xref:ServiceClientCredential> بسيط يصادق باستخدام اسم مستخدم وكلمة مرور.
DefaultHttpClient	عميل HTTP يستخدم `node-fetch`.
ExpiringAccessTokenCache	يوفر تطبيق AccessTokenCache الذي يمسح AccessToken المخزن مؤقتا's بعد انتهاء صلاحيةOnTimestamp الذي تم تمريره.
HttpHeaders	مجموعة من أزواج مفتاح/قيمة عنوان HTTP.
RequestPolicyOptions	الخصائص الاختيارية التي يمكن استخدامها عند إنشاء RequestPolicy.
RestError	خطأ ناتج عن طلب HTTP إلى نقطة نهاية خدمة.
Serializer	يستخدم لتعيين كائنات الاستجابة الأولية إلى الأشكال النهائية. يساعد على تعبئة التواريخ وفك حزمها والأنواع الأخرى المشفرة التي ليست مضمنة في JSON. يسمح أيضا بسحب القيم من الرؤوس، بالإضافة إلى إدراج القيم والثوابت الافتراضية.
ServiceClient	يرسل ServiceClient طلبات الخدمة ويتلقى الاستجابات.
TopicCredentials	عنصر TopicCredentials يستخدم ل Azure Event Grid.
URLBuilder	فئة تتعامل مع إنشاء عناوين URL وتعديلها وتحليلها.
URLQuery	فئة تعالج جزء الاستعلام من URLBuilder.
WebResource	إنشاء كائن WebResource جديد. توفر هذه الفئة تجريدا عبر استدعاء REST من خلال كونها مكتبة / تنفيذ غير محدد والتفاف الخصائص الضرورية لبدء طلب.

الواجهات

AbortSignalLike	يسمح باجهاض الطلب عند إطلاق حدث "إحباط". متوافق مع المتصفح المضمن AbortSignal و polyfills الشائعة.
AccessToken	يمثل رمزا مميزا للوصول مع وقت انتهاء الصلاحية.
AccessTokenCache	يوفر ذاكرة تخزين مؤقت ل AccessToken الذي تم إرجاعه من TokenCredential.
ApiKeyCredentialOptions	يصف الخيارات التي سيتم توفيرها أثناء إنشاء مثيل ApiKeyCredentials
BaseMapper	التعريف الأساسي للمخطط. يمكن استخدامها لعناصر XML وJavaScript العادية.
CompositeMapper	معين يتكون من معينين آخرين.
CompositeMapperType	يساعد في إنشاء معين يصف كيفية تعيين مجموعة من خصائص كائن استنادا إلى معينين آخرين. يجب أن تكون إحدى الخصائص التالية موجودة فقط: `classNamemodelPropertiesadditionalProperties`.
DeserializationContentTypes	أنواع المحتوى التي تشير إلى أنه يجب إلغاء تسلسل استجابة العملية بطريقة معينة.
DeserializationOptions	خيارات لتكوين إلغاء تسلسل استجابة واجهة برمجة التطبيقات.
DictionaryMapper	مخطط يصف كائنات JavaScript العادية المستخدمة كأزواج مفاتيح/قيمة.
DictionaryMapperType	يساعد في إنشاء معين يصف كيفية تحليل قاموس القيم المعينة.
EnumMapper	معين يصف قيمة قائمة تعداد.
EnumMapperType	يساعد في إنشاء معين يصف كيفية تحليل قيمة قائمة تعداد.
GetTokenOptions	يحدد خيارات TokenCredential.getToken.
HttpClient	واجهة يمكنها إرسال طلبات Http وتلقي HttpResponses الموعودة.
HttpHeader	رأس فردي ضمن مجموعة HttpHeaders.
HttpHeadersLike	مجموعة من أزواج مفتاح/قيمة عنوان HTTP.
HttpOperationResponse	كائن برنامج التضمين لطلب واستجابة http. يتم تخزين الكائن الذي تم إلغاء تسلسله في الخاصية `parsedBody` عند تلقي نص الاستجابة في JSON أو XML.
HttpPipelineLogger	مسجل يمكن إضافته إلى HttpPipeline. وهذا يمكن كل RequestPolicy من تسجيل الرسائل التي يمكن استخدامها لأغراض تصحيح الأخطاء.
HttpResponse	الخصائص على استجابة HTTP التي ستكون موجودة دائما.
InternalPipelineOptions	يحدد الخيارات المستخدمة لتكوين الخيارات الداخلية لمسار HTTP لعميل SDK.
KeepAliveOptions	خيارات لكيفية الاحتفاظ باتصالات HTTP للطلبات المستقبلية.
LogPolicyOptions	خيارات لتمريرها إلى logPolicy. بشكل افتراضي، يتم تسجيل قائمة مجموعة من الرؤوس فقط، على الرغم من أنه يمكن تكوين هذا. لا يتم تسجيل هيئات الطلب والاستجابة أبدا.
MapperConstraints	وصف قيود القيمة المختلفة مثل نطاقات الأعداد الصحيحة وسلسلة regex.
OperationArguments	مجموعة من الخصائص التي تنطبق على استدعاء واحد لعملية.
OperationOptions	نوع الخيارات الأساسية لكافة العمليات.
OperationParameter	واجهة شائعة تقوم كافة معلمة العملية بتوسيعها.
OperationQueryParameter	معلمة لعملية ستتم إضافتها كمعلمة استعلام إلى طلب HTTP الخاص بالعملية.
OperationRequestOptions	الخيارات التي تسمح بتكوين معالجة طلبات HTTP التي تم إجراؤها بواسطة عملية SDK.
OperationResponse	OperationResponse الذي يمكن إرجاعه من طلب عملية لرمز حالة واحد.
OperationSpec	مواصفات تحدد كيفية تنفيذ عملية خدمة معينة عبر HTTP، بما في ذلك كيفية تسلسل معلومات الطلب بشكل صحيح في معلومات الاستجابة وإلغاء تسلسلها في حمولة كائن قابلة للإرجاع بواسطة ServiceClient.
OperationURLParameter	معلمة لعملية سيتم استبدالها في عنوان URL لطلب العملية.
ParameterValue	قيمة المعلمة المتوفرة لمعلمات المسار أو الاستعلام في RequestPrepareOptions
PipelineOptions	يحدد الخيارات المستخدمة لتكوين البنية الأساسية لبرنامج ربط العمليات التجارية HTTP لعميل SDK.
PolymorphicDiscriminator	تستخدم لإزالة الغموض عن اتحادات النوع التمييزي. على سبيل المثال، إذا كان يمكن أن تحتوي الاستجابة على العديد من الأشكال ولكنها تتضمن أيضا حقل "نوع" (أو ما شابه ذلك)، يمكن استخدام هذا الحقل لتحديد كيفية إلغاء تسلسل الاستجابة إلى النوع الصحيح.
ProxySettings	خيارات لتكوين وكيل للطلبات الصادرة (Node.js فقط).
RedirectOptions	خيارات لكيفية معالجة استجابات إعادة التوجيه.
RequestOptionsBase	توضح هذه المقالة البنية الأساسية لكائن الخيارات التي سيتم استخدامها في كل عملية.
RequestPolicy	البنية الأساسية لنهج الطلب.
RequestPolicyOptionsLike	الخصائص الاختيارية التي يمكن استخدامها عند إنشاء RequestPolicy.
RequestPrepareOptions	خيارات لإعداد طلب HTTP صادر.
RestResponse	الاستجابة المبسطة لاستدعاء REST. يحتوي على HttpOperationResponse الأساسية بالإضافة إلى الخصائص المدمجة `parsedBodyparsedHeaders`وما إلى ذلك.
RetryOptions	الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.
SequenceMapper	معين يصف الصفائف.
SequenceMapperType	يساعد في إنشاء معين يصف كيفية توزيع تسلسل من القيم المعينة.
SerializerOptions	خيارات لتنظيم سلوك محلل xml ومنشئه.
ServiceCallback
ServiceClientCredentials	يمثل كائنا أو فئة باستخدام أسلوب `signRequest` الذي سيقوم بتسجيل الطلبات الصادرة (على سبيل المثال، عن طريق تعيين عنوان `Authorization`).
ServiceClientOptions	الخيارات التي سيتم توفيرها أثناء إنشاء العميل.
SimpleMapperType	نوع معين بسيط.
TokenCredential	يمثل بيانات اعتماد قادرة على توفير رمز مميز للمصادقة.
TracingPolicyOptions	خيارات لتخصيص نهج التتبع.
UrlParameterValue	واجهة تمثل قيمة معلمة عنوان URL.
UserAgentOptions	خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.
WebResourceLike	وصف لطلب HTTP الذي سيتم إجراؤه إلى خادم بعيد.

النوع أسماء مستعارة

Authenticator	دالة تتلقى تحديا وتحل وعدا برمز مميز للسلسلة.
CommonRequestInfo	عناوين URL للسلسلة المستخدمة عند الاتصال `fetch()`.
CommonRequestInit	كائن يحتوي على معلومات حول طلب HTTP الصادر.
CommonResponse	كائن يحتوي على معلومات حول استجابة HTTP الواردة.
HttpMethods	قائمة أساليب HTTP المدعومة.
HttpRequestBody	أنواع نص طلب HTTP المحتملة
Mapper	Mappers هي تعريفات لنماذج البيانات المستخدمة في المكتبة. نماذج البيانات هذه هي جزء من تعريفات العملية أو العميل في الاستجابات أو المعلمات.
ParameterPath	مسار يصف كيفية الوصول إلى خاصية معينة في مصدر بيانات كائن معين. قد يكون اسم خاصية واحدة أو صفيف يشير إلى أسماء الخصائص المتداخلة أو مجموعة من الخصائص المسماة المتعددة مع مسارات في حالة قيم الكائن المعقدة.
ProxyOptions	اسم مستعار ProxySettings للاستخدام في المستقبل.
RawHttpHeaders	يتم تمثيل مجموعة HttpHeaders ككائن JSON بسيط.
RequestPolicyFactory	إنشاء RequestPolicy لكل طلب جديد يستخدم nextPolicy المتوفرة.
TelemetryInfo	معلومات القياس عن بعد. أزواج المفاتيح/القيم لتضمينها داخل سلسلة User-Agent.
TransferProgressEvent	تم إطلاقه استجابة للتقدم في التحميل أو التنزيل.

التعدادات

HttpPipelineLogLevel	المستويات المختلفة للسجلات التي يمكن استخدامها مع HttpPipelineLogger.
QueryCollectionFormat	التنسيق الذي سيتم استخدامه لضم صفيف من القيم معا لقيمة معلمة استعلام.
RetryMode	يصف نوع وضع إعادة المحاولة. حاليا دعم الأسي فقط.

الوظائف

applyMixins(unknown, any[])	تطبيق الخصائص على النموذج الأولي ل sourceCtors على النموذج الأولي ل targetCtor
bearerTokenAuthenticationPolicy(TokenCredential, string \| string[])	إنشاء مصنع جديد ل RequestPolicy الذي يطبق رمز حامل على رؤوس `Authorization` الطلبات.
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	إنشاء مسار HTTP استنادا إلى الخيارات المحددة.
delay(number, DelayOptions)	برنامج تضمين ل setTimeout الذي يحل الوعد بعد timeInMs مللي ثانية.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	إنشاء تسلسل جديد RequestPolicyCreator الذي سيقوم بتسلسل هيئات طلب HTTP أثناء مرورها عبر البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	نظرا لمجموعة معينة من أنواع المحتويات لتحليلها إما ك JSON أو XML، تستهلك استجابة HTTP لإنتاج كائن النتيجة المحدد بواسطة OperationSpec للطلب.
disableResponseDecompressionPolicy()	إرجاع مصنع نهج طلب يمكن استخدامه لإنشاء مثيل <xref:DisableResponseDecompressionPolicy>.
encodeUri(string)	ترميز URI.
executePromisesSequentially(any[], unknown)	تنفيذ مجموعة من الوعود بالتتابع. مصدر إلهام لهذا الأسلوب هنا: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. مدونة رهيبة على وعود!
exponentialRetryPolicy(number, number, number)	النهج الذي يعيد محاولة الطلب عدة مرات كما تم تكوينه طالما تم تحديد الحد الأقصى للفاصل الزمني لإعادة المحاولة، كل إعادة محاولة تنتظر وقتا أطول للبدء من المرة الأخيرة.
flattenResponse(HttpOperationResponse, undefined \| OperationResponse)	تحليل httpOperationResponse في كائن استجابة HTTP تمت تسويته (restResponse).
generateClientRequestIdPolicy(string)	إنشاء نهج يعين معرف طلب فريد للطلبات الصادرة.
generateUuid()	UUID الذي تم إنشاؤه
getDefaultProxySettings(string)	يحول عنوان URL معينا لخادم وكيل إلى `ProxySettings` أو يحاول استرداد `ProxySettings` من البيئة الحالية إذا لم يتم تمريره.
getDefaultUserAgentValue()	النهج الافتراضي لإنشاء وكلاء المستخدمين. يستخدم معلومات ثابتة من هذه الحزمة، بالإضافة إلى معلومات النظام المتوفرة من وقت التشغيل.
isDuration(string)	يشير إلى ما إذا كانت السلسلة المحددة بتنسيق ISO 8601.
isTokenCredential(unknown)	اختبار كائن لتحديد ما إذا كان ينفذ TokenCredential.
isValidUuid(string)	التحقق من صحة uuid المحدد كسلسلة
keepAlivePolicy(KeepAliveOptions)	إنشاء نهج يتحكم في ما إذا كان يتم الاحتفاظ باتصالات HTTP على الطلبات المستقبلية.
logPolicy(LogPolicyOptions)	إنشاء نهج يسجل معلومات حول الطلب الصادر والاستجابات الواردة.
operationOptionsToRequestOptionsBase<T>(T)	تحويل OperationOptions إلى RequestOptionsBase
parseXML(string, SerializerOptions)	تحويل سلسلة XML المحددة إلى JSON
promiseToCallback(Promise<any>)	تحويل وعد إلى رد اتصال.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	تحويل وعد إلى رد اتصال خدمة.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	نهج يسمح لأحد بتطبيق إعدادات الوكيل على جميع الطلبات. إذا لم يتم تمرير الإعدادات الثابتة، استردادها من متغيرات البيئة HTTPS_PROXY أو HTTP_PROXY.
redirectPolicy(number)	إنشاء نهج إعادة توجيه، الذي يرسل تكرار الطلب إلى وجهة جديدة إذا وصلت استجابة مع عنوان "الموقع"، ورمز الحالة بين 300 و307.
serializeObject(unknown)	دالة الأداة المساعدة التي تقوم بتسلسل كائن قد يحتوي على معلومات ثنائية في كائن عادي أو صفيف أو سلسلة.
signingPolicy(ServiceClientCredentials)	إنشاء نهج يقوم بتسجيل الطلبات الصادرة عن طريق الاتصال بطريقة `authenticationProvidersignRequest`المتوفرة.
stringifyXML(unknown, SerializerOptions)	تحويل كائن JSON المحدد إلى سلسلة XML
stripRequest(WebResourceLike)	إرجاع إصدار تم تجريده من طلب Http لا يحتوي على عنوان التخويل.
stripResponse(HttpOperationResponse)	إرجاع إصدار تم تجريده من استجابة Http الذي يحتوي فقط على النص الأساسي والرؤوس والحالة.
systemErrorRetryPolicy(number, number, number, number)	نهج يعيد المحاولة عند وجود خطأ في النظام، تم تحديده بواسطة الرموز "ETIMEDOUT" أو "ESOCKETTIMEDOUT" أو "ECONNREFUSED" أو "ECONNRESET" أو "ENOENT".
throttlingRetryPolicy()	إنشاء نهج يعيد إرسال الطلب إذا كانت الاستجابة تشير إلى فشل الطلب لأسباب تتعلق بالتقييد. على سبيل المثال، إذا كانت الاستجابة تحتوي على عنوان `Retry-After`، فستعيد محاولة إرسال الطلب استنادا إلى قيمة هذا العنوان. لمعرفة المزيد، يرجى الرجوع إلى https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tracingPolicy(TracingPolicyOptions)	إنشاء نهج يلتف الطلبات الصادرة مع امتداد التتبع.
userAgentPolicy(TelemetryInfo)	إرجاع نهج يضيف عنوان عامل المستخدم إلى الطلبات الصادرة استنادا إلى المحدد TelemetryInfo.

المتغيرات

MapperType	يحتوي السلسلة الزمنية على أنواع السلاسل من ربطي الخصائص.
Constants	مجموعة من الثوابت تستخدم داخليا عند معالجة الطلبات.
XML_ATTRKEY	المفتاح الافتراضي المستخدم للوصول إلى سمات XML.
XML_CHARKEY	المفتاح الافتراضي المستخدم للوصول إلى محتوى قيمة XML.
isNode	ثابت يشير إلى ما إذا كانت البيئة التي يعمل بها الكود بيئة متوافقة Node.js.

تفاصيل الوظيفة

applyMixins(unknown, any[])

تطبيق الخصائص على النموذج الأولي ل sourceCtors على النموذج الأولي ل targetCtor

function applyMixins(targetCtorParam: unknown, sourceCtors: any[])

المعلمات

targetCtorParam: unknown

sourceCtors: any[]

صفيف من الكائنات المصدر التي يجب أخذ الخصائص منها.

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

إنشاء مصنع جديد ل RequestPolicy الذي يطبق رمز حامل على رؤوس Authorization الطلبات.

function bearerTokenAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory

المعلمات

credential: TokenCredential

تطبيق TokenCredential الذي يمكنه توفير الرمز المميز للحامل.

scopes: string | string[]

النطاقات التي ينطبق عليها الرمز المميز للحامل.

المرتجعات

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

إنشاء مسار HTTP استنادا إلى الخيارات المحددة.

function createPipelineFromOptions(pipelineOptions: InternalPipelineOptions, authPolicyFactory?: RequestPolicyFactory): ServiceClientOptions

المعلمات

pipelineOptions: InternalPipelineOptions

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

authPolicyFactory: RequestPolicyFactory

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

المرتجعات

ServiceClientOptions

مجموعة من الخيارات التي يمكن تمريرها لإنشاء ServiceClientجديد .

delay(number, DelayOptions)

برنامج تضمين ل setTimeout الذي يحل الوعد بعد timeInMs مللي ثانية.

function delay(timeInMs: number, options?: DelayOptions): Promise<void>

المعلمات

timeInMs: number

عدد المللي ثانية التي سيتم تأخيرها.

options: DelayOptions

خيارات التأخير - خيارات التعطل حاليا

المرتجعات

Promise<void>

الوعد الذي تم حله بعد timeInMs

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

إنشاء تسلسل جديد RequestPolicyCreator الذي سيقوم بتسلسل هيئات طلب HTTP أثناء مرورها عبر البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

المعلمات

deserializationContentTypes: DeserializationContentTypes

parsingOptions: SerializerOptions

المرتجعات

RequestPolicyFactory

deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)

نظرا لمجموعة معينة من أنواع المحتويات لتحليلها إما ك JSON أو XML، تستهلك استجابة HTTP لإنتاج كائن النتيجة المحدد بواسطة OperationSpec للطلب.

function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse, options?: SerializerOptions): Promise<HttpOperationResponse>

المعلمات

jsonContentTypes: string[]

أنواع محتوى الاستجابة لتحليل النص الأساسي ك JSON.

xmlContentTypes: string[]

أنواع محتوى الاستجابة لتحليل النص الأساسي ك XML.

response: HttpOperationResponse

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

options: SerializerOptions

خيارات للمسلسل، غالبا لتكوين محلل XML إذا لزم الأمر.

المرتجعات

Promise<HttpOperationResponse>

كائن HttpOperationResponse الذي يمكن إرجاعه بواسطة serviceClient.

disableResponseDecompressionPolicy()

إرجاع مصنع نهج طلب يمكن استخدامه لإنشاء مثيل <xref:DisableResponseDecompressionPolicy>.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

المرتجعات

RequestPolicyFactory

encodeUri(string)

ترميز URI.

function encodeUri(uri: string): string

المعلمات

uri: string

URI المراد ترميزه.

المرتجعات

string

URI المشفرة.

executePromisesSequentially(any[], unknown)

تنفيذ مجموعة من الوعود بالتتابع. مصدر إلهام لهذا الأسلوب هنا: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. مدونة رهيبة على وعود!

function executePromisesSequentially(promiseFactories: any[], kickstart: unknown): Promise<any>

المعلمات

promiseFactories: any[]

مجموعة من مصانع الوعد (دالة ترجع وعدا)

kickstart: unknown

إدخال إلى الوعد الأول الذي يستخدم لبدء سلسلة الوعد. إذا لم يتم توفيرها، تبدأ سلسلة الوعد ب غير محددة.

المرتجعات

Promise<any>

سلسلة من الوعود التي تم حلها أو رفضها

exponentialRetryPolicy(number, number, number)

النهج الذي يعيد محاولة الطلب عدة مرات كما تم تكوينه طالما تم تحديد الحد الأقصى للفاصل الزمني لإعادة المحاولة، كل إعادة محاولة تنتظر وقتا أطول للبدء من المرة الأخيرة.

function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

المعلمات

retryCount: number

الحد الأقصى لعدد مرات إعادة المحاولة.

retryInterval: number

الوقت الأساسي بين عمليات إعادة المحاولة.

maxRetryInterval: number

الحد الأقصى للوقت للانتظار بين عمليات إعادة المحاولة.

المرتجعات

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

تحليل httpOperationResponse في كائن استجابة HTTP تمت تسويته (restResponse).

function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse

المعلمات

_response: HttpOperationResponse

كائن برنامج التضمين لاستجابة http.

responseSpec: undefined | OperationResponse

المعينون لكيفية تحليل خصائص الاستجابة.

المرتجعات

RestResponse

كائن استجابة تمت تسويته.

generateClientRequestIdPolicy(string)

إنشاء نهج يعين معرف طلب فريد للطلبات الصادرة.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

المعلمات

requestIdHeaderName: string

اسم العنوان المراد استخدامه عند تعيين المعرف الفريد للطلب.

المرتجعات

RequestPolicyFactory

generateUuid()

UUID الذي تم إنشاؤه

function generateUuid(): string

المرتجعات

string

RFC4122 uuid v4.

getDefaultProxySettings(string)

يحول عنوان URL معينا لخادم وكيل إلى ProxySettings أو يحاول استرداد ProxySettings من البيئة الحالية إذا لم يتم تمريره.

function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined

المعلمات

proxyUrl: string

عنوان URL للوكيل

المرتجعات

ProxySettings | undefined

إعدادات الوكيل الافتراضية، أو غير محددة.

getDefaultUserAgentValue()

النهج الافتراضي لإنشاء وكلاء المستخدمين. يستخدم معلومات ثابتة من هذه الحزمة، بالإضافة إلى معلومات النظام المتوفرة من وقت التشغيل.

function getDefaultUserAgentValue(): string

المرتجعات

string

isDuration(string)

يشير إلى ما إذا كانت السلسلة المحددة بتنسيق ISO 8601.

function isDuration(value: string): boolean

المعلمات

value: string

القيمة التي سيتم التحقق من صحتها لتنسيق مدة ISO 8601.

المرتجعات

boolean

true إذا كان صالحا، false خلاف ذلك.

isTokenCredential(unknown)

اختبار كائن لتحديد ما إذا كان ينفذ TokenCredential.

function isTokenCredential(credential: unknown): credential

المعلمات

credential: unknown

تم اختبار TokenCredential المفترض.

المرتجعات

credential

isValidUuid(string)

التحقق من صحة uuid المحدد كسلسلة

function isValidUuid(uuid: string): boolean

المعلمات

uuid: string

uuid كسلسلة تحتاج إلى التحقق من صحتها

المرتجعات

boolean

صحيح إذا كان uuid صالحا؛ خطأ خلاف ذلك.

keepAlivePolicy(KeepAliveOptions)

إنشاء نهج يتحكم في ما إذا كان يتم الاحتفاظ باتصالات HTTP على الطلبات المستقبلية.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

المعلمات

keepAliveOptions: KeepAliveOptions

احتفظ بخيارات حية. بشكل افتراضي، يتم الاحتفاظ باتصالات HTTP للطلبات المستقبلية.

المرتجعات

RequestPolicyFactory

مثيل <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

إنشاء نهج يسجل معلومات حول الطلب الصادر والاستجابات الواردة.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

المعلمات

loggingOptions: LogPolicyOptions

خيارات التسجيل.

المرتجعات

RequestPolicyFactory

مثيل <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

تحويل OperationOptions إلى RequestOptionsBase

function operationOptionsToRequestOptionsBase<T>(opts: T): RequestOptionsBase

المعلمات

opts: T

كائن OperationOptions للتحويل إلى RequestOptionsBase

المرتجعات

RequestOptionsBase

parseXML(string, SerializerOptions)

تحويل سلسلة XML المحددة إلى JSON

function parseXML(str: string, opts?: SerializerOptions): Promise<any>

المعلمات

str: string

سلسلة تحتوي على محتوى XML ليتم تحليلها في JSON

opts: SerializerOptions

الخيارات التي تحكم تحليل سلسلة xml المحددة

المرتجعات

Promise<any>

promiseToCallback(Promise<any>)

تحذير

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

generated code should instead depend on responseToBody

تحويل وعد إلى رد اتصال.

function promiseToCallback(promise: Promise<any>): (cb: Function) => void

المعلمات

promise: Promise<any>

الوعد الذي سيتم تحويله إلى رد اتصال

المرتجعات

(cb: Function) => void

دالة تأخذ رد الاتصال (cb: Function) => void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

تحويل وعد إلى رد اتصال خدمة.

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): (cb: ServiceCallback<T>) => void

المعلمات

promise: Promise<HttpOperationResponse>

وعد HttpOperationResponse لتحويله إلى رد اتصال خدمة

المرتجعات

(cb: ServiceCallback<T>) => void

دالة تأخذ معاودة الاتصال بالخدمة (cb: ServiceCallback<T>): باطلة

proxyPolicy(ProxySettings, { customNoProxyList?: string[] })

نهج يسمح لأحد بتطبيق إعدادات الوكيل على جميع الطلبات. إذا لم يتم تمرير الإعدادات الثابتة، استردادها من متغيرات البيئة HTTPS_PROXY أو HTTP_PROXY.

function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): RequestPolicyFactory

المعلمات

proxySettings: ProxySettings

ProxySettings لاستخدامها في كل طلب.

options: { customNoProxyList?: string[] }

إعدادات إضافية، على سبيل المثال، أنماط NO_PROXY مخصصة

المرتجعات

RequestPolicyFactory

redirectPolicy(number)

إنشاء نهج إعادة توجيه، الذي يرسل تكرار الطلب إلى وجهة جديدة إذا وصلت استجابة مع عنوان "الموقع"، ورمز الحالة بين 300 و307.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

المعلمات

maximumRetries: number

الحد الأقصى لعدد عمليات إعادة التوجيه التي يجب اتباعها.

المرتجعات

RequestPolicyFactory

مثيل <xref:RedirectPolicy>

serializeObject(unknown)

دالة الأداة المساعدة التي تقوم بتسلسل كائن قد يحتوي على معلومات ثنائية في كائن عادي أو صفيف أو سلسلة.

function serializeObject(toSerialize: unknown): any

المعلمات

toSerialize: unknown

المرتجعات

any

signingPolicy(ServiceClientCredentials)

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

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

المعلمات

authenticationProvider: ServiceClientCredentials

موفر المصادقة.

المرتجعات

RequestPolicyFactory

مثيل <xref:SigningPolicy>.

stringifyXML(unknown, SerializerOptions)

تحويل كائن JSON المحدد إلى سلسلة XML

function stringifyXML(obj: unknown, opts?: SerializerOptions): string

المعلمات

obj: unknown

كائن JSON الذي سيتم تحويله إلى سلسلة XML

opts: SerializerOptions

الخيارات التي تحكم تحليل كائن JSON المحدد

المرتجعات

string

stripRequest(WebResourceLike)

إرجاع إصدار تم تجريده من طلب Http لا يحتوي على عنوان التخويل.

function stripRequest(request: WebResourceLike): WebResourceLike

المعلمات

request: WebResourceLike

كائن طلب Http

المرتجعات

WebResourceLike

الإصدار المجرد من طلب Http.

stripResponse(HttpOperationResponse)

إرجاع إصدار تم تجريده من استجابة Http الذي يحتوي فقط على النص الأساسي والرؤوس والحالة.

function stripResponse(response: HttpOperationResponse): any

المعلمات

response: HttpOperationResponse

استجابة Http

المرتجعات

any

الإصدار المجرد من استجابة Http.

systemErrorRetryPolicy(number, number, number, number)

نهج يعيد المحاولة عند وجود خطأ في النظام، تم تحديده بواسطة الرموز "ETIMEDOUT" أو "ESOCKETTIMEDOUT" أو "ECONNREFUSED" أو "ECONNRESET" أو "ENOENT".

function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

المعلمات

retryCount: number

الحد الأقصى لعدد مرات إعادة المحاولة.

retryInterval: number

الفاصل الزمني لإعادة محاولة العميل بالمللي ثانية.

minRetryInterval: number

الحد الأدنى لإعادة المحاولة، بالمللي ثانية.

maxRetryInterval: number

الحد الأقصى للفاصل الزمني لإعادة المحاولة بالمللي ثانية.

المرتجعات

RequestPolicyFactory

مثيل <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

إنشاء نهج يعيد إرسال الطلب إذا كانت الاستجابة تشير إلى فشل الطلب لأسباب تتعلق بالتقييد. على سبيل المثال، إذا كانت الاستجابة تحتوي على عنوان Retry-After، فستعيد محاولة إرسال الطلب استنادا إلى قيمة هذا العنوان.

function throttlingRetryPolicy(): RequestPolicyFactory

المرتجعات

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

إنشاء نهج يلتف الطلبات الصادرة مع امتداد التتبع.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

المعلمات

tracingOptions: TracingPolicyOptions

خيارات التتبع.

المرتجعات

RequestPolicyFactory

مثيل لفئة <xref:TracingPolicy>.

userAgentPolicy(TelemetryInfo)

إرجاع نهج يضيف عنوان عامل المستخدم إلى الطلبات الصادرة استنادا إلى المحدد TelemetryInfo.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

المعلمات

userAgentData: TelemetryInfo

معلومات القياس عن بعد.

المرتجعات

RequestPolicyFactory

<xref:UserAgentPolicy>جديد .

Variable Details

MapperType

يحتوي السلسلة الزمنية على أنواع السلاسل من ربطي الخصائص.

MapperType: { Base64Url: "Base64Url", Boolean: "Boolean", ByteArray: "ByteArray", Composite: "Composite", Date: "Date", DateTime: "DateTime", DateTimeRfc1123: "DateTimeRfc1123", Dictionary: "Dictionary", Enum: "Enum", Number: "Number", Object: "Object", Sequence: "Sequence", Stream: "Stream", String: "String", TimeSpan: "TimeSpan", UnixTime: "UnixTime" }

النوع

{ Base64Url: "Base64Url", Boolean: "Boolean", ByteArray: "ByteArray", Composite: "Composite", Date: "Date", DateTime: "DateTime", DateTimeRfc1123: "DateTimeRfc1123", Dictionary: "Dictionary", Enum: "Enum", Number: "Number", Object: "Object", Sequence: "Sequence", Stream: "Stream", String: "String", TimeSpan: "TimeSpan", UnixTime: "UnixTime" }

Constants

مجموعة من الثوابت تستخدم داخليا عند معالجة الطلبات.

Constants: { ALL_PROXY: string, HTTP: string, HTTPS: string, HTTPS_PROXY: string, HTTP_PROXY: string, HeaderConstants: { AUTHORIZATION: string, AUTHORIZATION_SCHEME: string, RETRY_AFTER: string, USER_AGENT: string }, HttpConstants: { HttpVerbs: { DELETE: string, GET: string, HEAD: string, MERGE: string, PATCH: string, POST: string, PUT: string }, StatusCodes: { ServiceUnavailable: number, TooManyRequests: number } }, NO_PROXY: string, coreHttpVersion: string }

النوع

{ ALL_PROXY: string, HTTP: string, HTTPS: string, HTTPS_PROXY: string, HTTP_PROXY: string, HeaderConstants: { AUTHORIZATION: string, AUTHORIZATION_SCHEME: string, RETRY_AFTER: string, USER_AGENT: string }, HttpConstants: { HttpVerbs: { DELETE: string, GET: string, HEAD: string, MERGE: string, PATCH: string, POST: string, PUT: string }, StatusCodes: { ServiceUnavailable: number, TooManyRequests: number } }, NO_PROXY: string, coreHttpVersion: string }

XML_ATTRKEY

المفتاح الافتراضي المستخدم للوصول إلى سمات XML.

XML_ATTRKEY: "$"

النوع

"$"

XML_CHARKEY

المفتاح الافتراضي المستخدم للوصول إلى محتوى قيمة XML.

XML_CHARKEY: "_"

النوع

"_"

isNode

تحذير

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

Use isNodeLike instead.

ثابت يشير إلى ما إذا كانت البيئة التي يعمل بها الكود بيئة متوافقة Node.js.

isNode: boolean

النوع

boolean