@azure/core-https package

الفصول

DefaultHttpsClient	تطبيق HttpsClient يستخدم وحدة "https" الخاصة بالعقدة لإرسال طلبات HTTPS.
RestError	نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة.

الواجهات

AddPipelineOptions	خيارات عند إضافة نهج إلى البنية الأساسية لبرنامج ربط العمليات التجارية. يستخدم للتعبير عن التبعيات على النهج الأخرى.
BearerTokenAuthenticationPolicyOptions	خيارات لتكوين bearerTokenAuthenticationPolicy
ExponentialRetryPolicyOptions	الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.
HttpHeaders	يمثل مجموعة من عناوين HTTP على طلب/استجابة. يتم التعامل مع أسماء العناوين على أنها غير حساسة لحالة الأحرف.
HttpsClient	الواجهة المطلوبة للعميل الذي يقوم بتقديم طلبات HTTPS نيابة عن خط الأنابيب.
InternalPipelineOptions	يحدد الخيارات المستخدمة لتكوين الخيارات الداخلية لمسار HTTP لعميل SDK.
LogPolicyOptions	خيارات لتكوين logPolicy.
Pipeline	يمثل البنية الأساسية لبرنامج ربط العمليات التجارية لإجراء طلب HTTPS إلى عنوان URL. يمكن أن يكون للبنية الأساسية لبرنامج ربط العمليات التجارية نهج متعددة لإدارة معالجة كل طلب قبل وبعد تقديمه إلى الخادم.
PipelineOptions	يحدد الخيارات المستخدمة لتكوين البنية الأساسية لبرنامج ربط العمليات التجارية HTTP لعميل SDK.
PipelinePolicy	يعالج نهج البنية الأساسية لبرنامج ربط العمليات التجارية طلبا أثناء تنقله عبر البنية الأساسية لبرنامج ربط العمليات التجارية. من الناحية المفاهيمية هو برنامج وسيط يسمح بتعديل الطلب قبل تقديمه بالإضافة إلى الاستجابة عند تلقيه.
PipelineRequest	بيانات التعريف حول طلب يتم إجراؤه بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية.
PipelineRequestOptions	إعدادات لتهيئة طلب. يكاد يكون مكافئا ل Partial<PipelineRequest>، ولكن عنوان url إلزامي.
PipelineResponse	بيانات التعريف حول استجابة تم تلقيها بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية.
ProxySettings	خيارات لتكوين وكيل للطلبات الصادرة (Node.js فقط).
RedirectPolicyOptions	خيارات لكيفية معالجة استجابات إعادة التوجيه.
RestErrorOptions	الخيارات التي يدعمها RestError.
SystemErrorRetryPolicyOptions	الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.
TracingPolicyOptions	خيارات لتكوين نهج التتبع.
UserAgentPolicyOptions	خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.

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

FormDataMap	كائن بسيط يوفر بيانات النموذج، كما لو كان من نموذج مستعرض.
FormDataValue	يمكن أن يكون كل إدخال بيانات نموذج سلسلة أو (في المستعرض) كائن ثنائي كبير الحجم.
HttpMethods	أساليب HTTP المدعومة لاستخدامها عند تقديم الطلبات.
PipelinePhase	يتم تنفيذ النهج على مراحل. أمر التنفيذ هو: مرحلة التسلسل النهج ليست في مرحلة إلغاء تسلسل المرحلة مرحلة إعادة المحاولة
RawHttpHeaders	يتم تمثيل مجموعة HttpHeaders ككائن JSON بسيط.
RequestBodyType	أنواع الهيئات المدعومة بناء على الطلب. NodeJS.ReadableStream هو العقدة فقط. Blob هو متصفح فقط.
SendRequest	واجهة بسيطة لإجراء طلب البنية الأساسية لبرنامج ربط العمليات التجارية وتلقي استجابة.
TransferProgressEvent	تم إطلاقه استجابة للتقدم في التحميل أو التنزيل.

الوظائف

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	نهج يمكنه طلب رمز مميز من تطبيق TokenCredential ثم تطبيقه على عنوان التخويل لطلب كرمز مميز لحامله.
createEmptyPipeline()	إنشاء البنية الأساسية لبرنامج ربط العمليات التجارية فارغة تماما. مفيد لاختبار أو إنشاء واحد مخصص.
createHttpHeaders(RawHttpHeaders)	إنشاء كائن يفي بواجهة `HttpHeaders`.
createPipelineFromOptions(InternalPipelineOptions)	إنشاء مسار جديد مع مجموعة افتراضية من النهج القابلة للتخصيص.
createPipelineRequest(PipelineRequestOptions)	إنشاء طلب مسار جديد مع الخيارات المحددة. هذا الأسلوب هو للسماح بالإعداد السهل للقيم الافتراضية وليس مطلوبا.
decompressResponsePolicy()	نهج لتمكين إلغاء ضغط الاستجابة وفقا لعنوان Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	نهج يحاول إعادة محاولة الطلبات أثناء تقديم تأخير متزايد بشكل كبير.
formDataPolicy()	نهج يقوم بترميز FormData على الطلب في النص الأساسي.
getDefaultProxySettings(string)	يحول هذا الأسلوب عنوان url للوكيل إلى `ProxySettings` للاستخدام مع ProxyPolicy. إذا لم يتم إعطاء أي وسيطة، فإنها تحاول تحليل عنوان URL للوكيل من متغيرات البيئة `HTTPS_PROXY` أو `HTTP_PROXY`.
logPolicy(LogPolicyOptions)	نهج يسجل جميع الطلبات والاستجابات.
ndJsonPolicy()	ndJsonPolicy هو نهج يستخدم للتحكم في إعدادات الاحتفاظ بالحيوية لكل طلب.
proxyPolicy(ProxySettings)	نهج يسمح لأحد بتطبيق إعدادات الوكيل على جميع الطلبات. إذا لم يتم تمرير الإعدادات الثابتة، استردادها من متغيرات البيئة HTTPS_PROXY أو HTTP_PROXY.
redirectPolicy(RedirectPolicyOptions)	نهج لمتابعة عناوين الموقع من الخادم لدعم إعادة التوجيه من جانب الخادم.
setClientRequestIdPolicy(string)	يحصل كل PipelineRequest على معرف فريد عند الإنشاء. يمرر هذا النهج هذا المعرف الفريد عبر عنوان HTTP لتمكين بيانات تتبع الاستخدام والتتبع بشكل أفضل.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	نهج إعادة المحاولة الذي يسعى خصيصا لمعالجة الأخطاء في طبقة النقل الأساسية (على سبيل المثال، فشل بحث DNS) بدلا من رموز الخطأ القابلة لإعادة المحاولة من الخادم نفسه.
throttlingRetryPolicy()	نهج يعيد المحاولة عندما يرسل الخادم استجابة 429 مع عنوان 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)	نهج بسيط لإنشاء OpenTelemetry Spans لكل طلب يتم إجراؤه بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية التي تحتوي على SpanOptions مع أصل. لن يتم تسجيل الطلبات التي تم إجراؤها بدون نطاق أصل.
userAgentPolicy(UserAgentPolicyOptions)	نهج يعين عنوان User-Agent (أو ما يعادله) ليعكس إصدار المكتبة.

المتغيرات

bearerTokenAuthenticationPolicyName	المعرف البرمجي لحامل سياسة TokenAuthenticationPolicy.
decompressResponsePolicyName	المعرف البرمجي لسياسة فك الضغط.
expontentialRetryPolicyName	المعرف البرمجي لسياسة RetryPolicy الأسية.
formDataPolicyName	المعرف البرمجي لنموذج DataPolicy.
logPolicyName	المعرف البرمجي للسياسة اللوغية.
ndJsonPolicyName	المعرف البرمجي لسياسة ndJson.
proxyPolicyName	المعرف البرمجي لسياسة الوكيل.
redirectPolicyName	المعرف البرمجي لسياسة إعادة التوجيه.
setClientRequestIdPolicyName	المعرف البرمجي لسياسة setClientRequestIdPolicy.
systemErrorRetryPolicyName	المعرف البرمجي لسياسة systemErrorRetryPolicy.
throttlingRetryPolicyName	المعرف البرمجي لسياسة التقييد RetryPolicy.
tracingPolicyName	المعرف البرمجي لسياسة التتبع.
userAgentPolicyName	المعرف البرمجي لسياسة الوكيل المستخدم (userAgentPolicy).

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

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

نهج يمكنه طلب رمز مميز من تطبيق TokenCredential ثم تطبيقه على عنوان التخويل لطلب كرمز مميز لحامله.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

المعلمات

options: BearerTokenAuthenticationPolicyOptions

المرتجعات

PipelinePolicy

createEmptyPipeline()

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

function createEmptyPipeline(): Pipeline

المرتجعات

Pipeline

createHttpHeaders(RawHttpHeaders)

إنشاء كائن يفي بواجهة HttpHeaders.

function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders

المعلمات

rawHeaders: RawHttpHeaders

كائن بسيط يمثل الرؤوس الأولية

المرتجعات

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

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

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

المعلمات

options: InternalPipelineOptions

خيارات لتكوين مسار مخصص.

المرتجعات

Pipeline

createPipelineRequest(PipelineRequestOptions)

إنشاء طلب مسار جديد مع الخيارات المحددة. هذا الأسلوب هو للسماح بالإعداد السهل للقيم الافتراضية وليس مطلوبا.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

المعلمات

options: PipelineRequestOptions

خيارات إنشاء الطلب باستخدام.

المرتجعات

PipelineRequest

decompressResponsePolicy()

نهج لتمكين إلغاء ضغط الاستجابة وفقا لعنوان Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

المرتجعات

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

نهج يحاول إعادة محاولة الطلبات أثناء تقديم تأخير متزايد بشكل كبير.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

المعلمات

options: ExponentialRetryPolicyOptions

الخيارات التي تقوم بتكوين منطق إعادة المحاولة.

المرتجعات

PipelinePolicy

formDataPolicy()

نهج يقوم بترميز FormData على الطلب في النص الأساسي.

function formDataPolicy(): PipelinePolicy

المرتجعات

PipelinePolicy

getDefaultProxySettings(string)

يحول هذا الأسلوب عنوان url للوكيل إلى ProxySettings للاستخدام مع ProxyPolicy. إذا لم يتم إعطاء أي وسيطة، فإنها تحاول تحليل عنوان URL للوكيل من متغيرات البيئة HTTPS_PROXY أو HTTP_PROXY.

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

المعلمات

proxyUrl: string

عنوان URL للوكيل المراد استخدامه. قد يحتوي على معلومات المصادقة.

المرتجعات

ProxySettings | undefined

logPolicy(LogPolicyOptions)

نهج يسجل جميع الطلبات والاستجابات.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

المعلمات

options: LogPolicyOptions

خيارات لتكوين logPolicy.

المرتجعات

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy هو نهج يستخدم للتحكم في إعدادات الاحتفاظ بالحيوية لكل طلب.

function ndJsonPolicy(): PipelinePolicy

المرتجعات

PipelinePolicy

proxyPolicy(ProxySettings)

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

function proxyPolicy(proxySettings?: ProxySettings): PipelinePolicy

المعلمات

proxySettings: ProxySettings

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

المرتجعات

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

نهج لمتابعة عناوين الموقع من الخادم لدعم إعادة التوجيه من جانب الخادم.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

المعلمات

options: RedirectPolicyOptions

خيارات للتحكم في سلوك النهج.

المرتجعات

PipelinePolicy

setClientRequestIdPolicy(string)

يحصل كل PipelineRequest على معرف فريد عند الإنشاء. يمرر هذا النهج هذا المعرف الفريد عبر عنوان HTTP لتمكين بيانات تتبع الاستخدام والتتبع بشكل أفضل.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

المعلمات

requestIdHeaderName: string

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

المرتجعات

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

نهج إعادة المحاولة الذي يسعى خصيصا لمعالجة الأخطاء في طبقة النقل الأساسية (على سبيل المثال، فشل بحث DNS) بدلا من رموز الخطأ القابلة لإعادة المحاولة من الخادم نفسه.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

المعلمات

options: SystemErrorRetryPolicyOptions

الخيارات التي تقوم بتخصيص النهج.

المرتجعات

PipelinePolicy

throttlingRetryPolicy()

نهج يعيد المحاولة عندما يرسل الخادم استجابة 429 مع عنوان Retry-After.

function throttlingRetryPolicy(): PipelinePolicy

المرتجعات

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

نهج بسيط لإنشاء OpenTelemetry Spans لكل طلب يتم إجراؤه بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية التي تحتوي على SpanOptions مع أصل. لن يتم تسجيل الطلبات التي تم إجراؤها بدون نطاق أصل.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

المعلمات

options: TracingPolicyOptions

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

المرتجعات

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

نهج يعين عنوان User-Agent (أو ما يعادله) ليعكس إصدار المكتبة.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

المعلمات

options: UserAgentPolicyOptions

خيارات لتخصيص قيمة عامل المستخدم.

المرتجعات

PipelinePolicy

Variable Details

bearerTokenAuthenticationPolicyName

المعرف البرمجي لحامل سياسة TokenAuthenticationPolicy.

bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"

النوع

"bearerTokenAuthenticationPolicy"

decompressResponsePolicyName

المعرف البرمجي لسياسة فك الضغط.

decompressResponsePolicyName: "decompressResponsePolicy"

النوع

"decompressResponsePolicy"

expontentialRetryPolicyName

المعرف البرمجي لسياسة RetryPolicy الأسية.

expontentialRetryPolicyName: "exponentialRetryPolicy"

النوع

"exponentialRetryPolicy"

formDataPolicyName

المعرف البرمجي لنموذج DataPolicy.

formDataPolicyName: "formDataPolicy"

النوع

"formDataPolicy"

logPolicyName

المعرف البرمجي للسياسة اللوغية.

logPolicyName: "logPolicy"

النوع

"logPolicy"

ndJsonPolicyName

المعرف البرمجي لسياسة ndJson.

ndJsonPolicyName: "ndJsonPolicy"

النوع

"ndJsonPolicy"

proxyPolicyName

المعرف البرمجي لسياسة الوكيل.

proxyPolicyName: "proxyPolicy"

النوع

"proxyPolicy"

redirectPolicyName

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

redirectPolicyName: "redirectPolicy"

النوع

"redirectPolicy"

setClientRequestIdPolicyName

المعرف البرمجي لسياسة setClientRequestIdPolicy.

setClientRequestIdPolicyName: "setClientRequestIdPolicy"

النوع

"setClientRequestIdPolicy"

systemErrorRetryPolicyName

المعرف البرمجي لسياسة systemErrorRetryPolicy.

systemErrorRetryPolicyName: "systemErrorRetryPolicy"

النوع

"systemErrorRetryPolicy"

throttlingRetryPolicyName

المعرف البرمجي لسياسة التقييد RetryPolicy.

throttlingRetryPolicyName: "throttlingRetryPolicy"

النوع

"throttlingRetryPolicy"

tracingPolicyName

المعرف البرمجي لسياسة التتبع.

tracingPolicyName: "tracingPolicy"

النوع

"tracingPolicy"

userAgentPolicyName

المعرف البرمجي لسياسة الوكيل المستخدم (userAgentPolicy).

userAgentPolicyName: "userAgentPolicy"

النوع

"userAgentPolicy"

الملاحظات

هل كانت هذه الصفحة مفيدة؟