@azure/core-rest-pipeline package
الفصول
RestError |
نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة. |
الواجهات
AddPipelineOptions |
خيارات عند إضافة نهج إلى البنية الأساسية لبرنامج ربط العمليات التجارية. يستخدم للتعبير عن التبعيات على النهج الأخرى. |
Agent |
واجهة متوافقة مع |
AuthorizeRequestOnChallengeOptions |
الخيارات المرسلة إلى رد اتصال authorizeRequestOnChallenge |
AuthorizeRequestOptions |
الخيارات المرسلة إلى رد اتصال authorizeRequest |
AuxiliaryAuthenticationHeaderPolicyOptions |
خيارات لتكوين نهج AuxiliaryAuthenticationHeaderPolicy |
BearerTokenAuthenticationPolicyOptions |
خيارات لتكوين bearerTokenAuthenticationPolicy |
BodyPart |
جزء من نص الطلب في طلب متعدد الأجزاء. |
ChallengeCallbacks |
خيارات لتجاوز معالجة تقييم الوصول المستمر التحديات. |
CreateFileFromStreamOptions |
خيارات إضافية لإنشاء ملف عند تمرير دفق. |
CreateFileOptions |
تم تمرير الخيارات إلى createFile لتحديد بيانات التعريف حول الملف. |
DefaultRetryPolicyOptions |
الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة. |
ExponentialRetryPolicyOptions |
الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة. |
HttpClient |
الواجهة المطلوبة لعميل يقوم بإجراء طلبات HTTP نيابة عن البنية الأساسية لبرنامج ربط العمليات التجارية. |
HttpHeaders |
يمثل مجموعة من عناوين HTTP على طلب/استجابة. يتم التعامل مع أسماء العناوين على أنها غير حساسة لحالة الأحرف. |
InternalPipelineOptions |
يحدد الخيارات المستخدمة لتكوين الخيارات الداخلية لمسار HTTP لعميل SDK. |
KeyObject |
واجهة متوافقة مع |
LogPolicyOptions |
خيارات لتكوين logPolicy. |
MultipartRequestBody |
نص طلب يتكون من أجزاء متعددة. |
Pipeline |
يمثل مسارا لإجراء طلب HTTP إلى عنوان URL. يمكن أن يكون للبنية الأساسية لبرنامج ربط العمليات التجارية نهج متعددة لإدارة معالجة كل طلب قبل وبعد تقديمه إلى الخادم. |
PipelineOptions |
يحدد الخيارات المستخدمة لتكوين البنية الأساسية لبرنامج ربط العمليات التجارية HTTP لعميل SDK. |
PipelinePolicy |
يعالج نهج البنية الأساسية لبرنامج ربط العمليات التجارية طلبا أثناء تنقله عبر البنية الأساسية لبرنامج ربط العمليات التجارية. من الناحية المفاهيمية هو برنامج وسيط يسمح بتعديل الطلب قبل تقديمه بالإضافة إلى الاستجابة عند تلقيه. |
PipelineRequest |
بيانات التعريف حول طلب يتم إجراؤه بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية. |
PipelineRequestOptions |
إعدادات لتهيئة طلب. مكافئ تقريبا ل Partial، ولكن url إلزامي. |
PipelineResponse |
بيانات التعريف حول استجابة تم تلقيها بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية. |
PipelineRetryOptions |
الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة. |
ProxySettings |
خيارات لتكوين وكيل للطلبات الصادرة (Node.js فقط). |
PxfObject |
واجهة متوافقة مع |
RedirectPolicyOptions |
خيارات لكيفية معالجة استجابات إعادة التوجيه. |
RestErrorOptions |
الخيارات التي يدعمها RestError. |
RetryInformation |
المعلومات المقدمة إلى استراتيجية إعادة المحاولة حول التقدم الحالي لنهج إعادة المحاولة. |
RetryModifiers |
الخصائص التي يمكنها تعديل سلوك نهج إعادة المحاولة. |
RetryPolicyOptions | |
RetryStrategy |
تهدف استراتيجية إعادة المحاولة إلى تحديد ما إذا كنت تريد إعادة المحاولة أم لا، وكيفية إعادة المحاولة. |
SystemErrorRetryPolicyOptions |
الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة. |
TelemetryOptions |
تحديد الخيارات المستخدمة لتكوين بيانات تتبع الاستخدام الشائعة ومعلومات التتبع |
ThrottlingRetryPolicyOptions |
الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة. |
TlsSettings |
يمثل شهادة لمصادقة TLS. |
TracingPolicyOptions |
خيارات لتكوين نهج التتبع. |
UserAgentPolicyOptions |
خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة. |
النوع أسماء مستعارة
FormDataMap |
كائن بسيط يوفر بيانات النموذج، كما لو كان من نموذج مستعرض. |
FormDataValue |
يمكن أن يكون كل إدخال بيانات نموذج سلسلة أو كائن ثنائي كبير الحجم أو ملف. إذا كنت ترغب في تمرير ملف باسم ولكن ليس لديك حق الوصول إلى فئة ملف، يمكنك استخدام مساعد createFile لإنشاء ملف. |
HttpMethods |
أساليب HTTP المدعومة لاستخدامها عند تقديم الطلبات. |
PipelinePhase |
يتم تنفيذ النهج على مراحل. أمر التنفيذ هو:
|
RawHttpHeaders |
يتم تمثيل مجموعة HttpHeaders ككائن JSON بسيط. |
RawHttpHeadersInput |
مجموعة HttpHeaders للإدخل، ممثلة ككائن JSON بسيط. |
RequestBodyType |
أنواع الهيئات المدعومة بناء على الطلب. NodeJS.ReadableStream و () => NodeJS.ReadableStream هي Node only. Blob و ReadableStream و () => ReadableStream هي مستعرض فقط. |
SendRequest |
واجهة بسيطة لإجراء طلب البنية الأساسية لبرنامج ربط العمليات التجارية وتلقي استجابة. |
TransferProgressEvent |
تم إطلاقه استجابة للتقدم في التحميل أو التنزيل. |
الوظائف
agent |
الحصول على نهج البنية الأساسية لبرنامج ربط العمليات التجارية الذي يعين http.agent |
auxiliary |
نهج الرموز المميزة الخارجية لعنوان |
bearer |
نهج يمكنه طلب رمز مميز من تطبيق TokenCredential ثم تطبيقه على عنوان التخويل لطلب كرمز مميز لحامله. |
create |
إنشاء HttpClient الصحيح للبيئة الحالية. |
create |
إنشاء البنية الأساسية لبرنامج ربط العمليات التجارية فارغة تماما. مفيد لاختبار أو إنشاء واحد مخصص. |
create |
إنشاء كائن ينفذ واجهة الملف. الغرض من هذا الكائن هو تمريره إلى RequestBodyType.formData، وهو غير مضمون للعمل كما هو متوقع في حالات أخرى. استخدم هذه الدالة إنشاء كائن ملف للاستخدام في RequestBodyType.formData في البيئات التي لا يتوفر فيها كائن الملف العمومي. |
create |
إنشاء كائن ينفذ واجهة الملف. الغرض من هذا الكائن هو تمريره إلى RequestBodyType.formData، وهو غير مضمون للعمل كما هو متوقع في حالات أخرى. استخدم هذه الدالة من أجل:
|
create |
إنشاء كائن يفي بواجهة |
create |
إنشاء مسار جديد مع مجموعة افتراضية من النهج القابلة للتخصيص. |
create |
إنشاء طلب مسار جديد مع الخيارات المحددة. هذا الأسلوب هو للسماح بالإعداد السهل للقيم الافتراضية وليس مطلوبا. |
decompress |
نهج لتمكين إلغاء ضغط الاستجابة وفقا لعنوان Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding |
default |
نهج يعيد المحاولة وفقا لثلاث استراتيجيات:
|
exponential |
نهج يحاول إعادة محاولة الطلبات أثناء تقديم تأخير متزايد بشكل كبير. |
form |
نهج يقوم بترميز FormData على الطلب في النص الأساسي. |
get |
يحول هذا الأسلوب عنوان url للوكيل إلى |
is |
Typeguard ل RestError |
log |
نهج يسجل جميع الطلبات والاستجابات. |
multipart |
نهج البنية الأساسية لبرنامج ربط العمليات التجارية للطلبات متعددة الأقسام |
nd |
ndJsonPolicy هو نهج يستخدم للتحكم في إعدادات الاحتفاظ بالحيوية لكل طلب. |
proxy |
نهج يسمح لأحد بتطبيق إعدادات الوكيل على جميع الطلبات. إذا لم يتم تمرير الإعدادات الثابتة، استردادها من متغيرات البيئة HTTPS_PROXY أو HTTP_PROXY. |
redirect |
نهج لمتابعة عناوين الموقع من الخادم لدعم إعادة التوجيه من جانب الخادم. في المستعرض، لا يتم استخدام هذا النهج. |
retry |
retryPolicy هو نهج عام لتمكين طلبات إعادة المحاولة عند استيفاء شروط معينة |
set |
يحصل كل PipelineRequest على معرف فريد عند الإنشاء. يمرر هذا النهج هذا المعرف الفريد عبر عنوان HTTP لتمكين بيانات تتبع الاستخدام والتتبع بشكل أفضل. |
system |
نهج إعادة المحاولة الذي يسعى خصيصا لمعالجة الأخطاء في طبقة النقل الأساسية (على سبيل المثال، فشل بحث DNS) بدلا من رموز الخطأ القابلة لإعادة المحاولة من الخادم نفسه. |
throttling |
نهج يعيد المحاولة عندما يرسل الخادم استجابة 429 مع عنوان Retry-After. لمعرفة المزيد، يرجى الرجوع إلى https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitshttps://learn.microsoft.com/en-us/azure/azure-subscription-service-limitshttps://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors |
tls |
يحصل على نهج البنية الأساسية لبرنامج ربط العمليات التجارية الذي يضيف شهادة العميل إلى عامل HttpClient للمصادقة. |
tracing |
نهج بسيط لإنشاء OpenTelemetry Spans لكل طلب يتم إجراؤه بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية التي تحتوي على SpanOptions مع أصل. لن يتم تسجيل الطلبات التي تم إجراؤها بدون نطاق أصل. |
user |
نهج يعين عنوان User-Agent (أو ما يعادله) ليعكس إصدار المكتبة. |
تفاصيل الوظيفة
agentPolicy(Agent)
الحصول على نهج البنية الأساسية لبرنامج ربط العمليات التجارية الذي يعين http.agent
function agentPolicy(agent?: Agent): PipelinePolicy
المعلمات
- agent
- Agent
المرتجعات
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)
نهج الرموز المميزة الخارجية لعنوان x-ms-authorization-auxiliary
.
سيتم استخدام هذا العنوان عند إنشاء تطبيق عبر المستأجرين قد نحتاج إلى معالجة طلبات المصادقة للموارد الموجودة في مستأجرين مختلفين.
يمكنك مشاهدة مستندات ARM لطريقة عمل هذه الميزة
function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy
المعلمات
المرتجعات
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)
نهج يمكنه طلب رمز مميز من تطبيق TokenCredential ثم تطبيقه على عنوان التخويل لطلب كرمز مميز لحامله.
function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy
المعلمات
المرتجعات
createDefaultHttpClient()
إنشاء HttpClient الصحيح للبيئة الحالية.
function createDefaultHttpClient(): HttpClient
المرتجعات
createEmptyPipeline()
إنشاء البنية الأساسية لبرنامج ربط العمليات التجارية فارغة تماما. مفيد لاختبار أو إنشاء واحد مخصص.
function createEmptyPipeline(): Pipeline
المرتجعات
createFile(Uint8Array, string, CreateFileOptions)
إنشاء كائن ينفذ واجهة الملف. الغرض من هذا الكائن هو تمريره إلى RequestBodyType.formData، وهو غير مضمون للعمل كما هو متوقع في حالات أخرى.
استخدم هذه الدالة إنشاء كائن ملف للاستخدام في RequestBodyType.formData في البيئات التي لا يتوفر فيها كائن الملف العمومي.
function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): File
المعلمات
- content
-
Uint8Array
محتوى الملف ك Uint8Array في الذاكرة.
- name
-
string
اسم الملف.
- options
- CreateFileOptions
بيانات التعريف الاختيارية حول الملف، على سبيل المثال اسم الملف وحجم الملف ونوع MIME.
المرتجعات
File
createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)
إنشاء كائن ينفذ واجهة الملف. الغرض من هذا الكائن هو تمريره إلى RequestBodyType.formData، وهو غير مضمون للعمل كما هو متوقع في حالات أخرى.
استخدم هذه الدالة من أجل:
- إنشاء كائن ملف للاستخدام في RequestBodyType.formData في البيئات التي يكون فيها كائن الملف العمومي غير متوفر.
- إنشاء كائن يشبه الملف من دفق قابل للقراءة دون قراءة الدفق في الذاكرة.
function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): File
المعلمات
- stream
-
() => ReadableStream<Uint8Array> | ReadableStream
محتوى الملف كرد اتصال يرجع دفق. عند تمرير كائن ملف تم إجراؤه باستخدام createFile في خريطة بيانات نموذج الطلب، لن تتم قراءة الدفق في الذاكرة وبدلا من ذلك سيتم دفقه عند إجراء الطلب. في حالة إعادة المحاولة، يجب قراءة الدفق مرة أخرى، لذلك يجب أن يؤدي رد الاتصال هذا إلى إرجاع دفق جديد إن أمكن.
- name
-
string
اسم الملف.
- options
- CreateFileFromStreamOptions
بيانات التعريف الاختيارية حول الملف، على سبيل المثال اسم الملف وحجم الملف ونوع MIME.
المرتجعات
File
createHttpHeaders(RawHttpHeadersInput)
إنشاء كائن يفي بواجهة HttpHeaders
.
function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders
المعلمات
- rawHeaders
- RawHttpHeadersInput
كائن بسيط يمثل الرؤوس الأولية
المرتجعات
createPipelineFromOptions(InternalPipelineOptions)
إنشاء مسار جديد مع مجموعة افتراضية من النهج القابلة للتخصيص.
function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline
المعلمات
- options
- InternalPipelineOptions
خيارات لتكوين مسار مخصص.
المرتجعات
createPipelineRequest(PipelineRequestOptions)
إنشاء طلب مسار جديد مع الخيارات المحددة. هذا الأسلوب هو للسماح بالإعداد السهل للقيم الافتراضية وليس مطلوبا.
function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest
المعلمات
- options
- PipelineRequestOptions
خيارات إنشاء الطلب باستخدام.
المرتجعات
decompressResponsePolicy()
نهج لتمكين إلغاء ضغط الاستجابة وفقا لعنوان Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
function decompressResponsePolicy(): PipelinePolicy
المرتجعات
defaultRetryPolicy(DefaultRetryPolicyOptions)
نهج يعيد المحاولة وفقا لثلاث استراتيجيات:
- عندما يرسل الخادم استجابة 429 مع عنوان Retry-After.
- عند وجود أخطاء في طبقة النقل الأساسية (على سبيل المثال، فشل بحث DNS).
- أو إذا فشل الطلب الصادر، فسيعيد المحاولة بتأخير متزايد بشكل كبير.
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy
المعلمات
- options
- DefaultRetryPolicyOptions
المرتجعات
exponentialRetryPolicy(ExponentialRetryPolicyOptions)
نهج يحاول إعادة محاولة الطلبات أثناء تقديم تأخير متزايد بشكل كبير.
function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy
المعلمات
- options
- ExponentialRetryPolicyOptions
الخيارات التي تقوم بتكوين منطق إعادة المحاولة.
المرتجعات
formDataPolicy()
نهج يقوم بترميز FormData على الطلب في النص الأساسي.
function formDataPolicy(): PipelinePolicy
المرتجعات
getDefaultProxySettings(string)
تحذير
واجهة برمجة التطبيقات هذه مهملة الآن.
- Internally this method is no longer necessary when setting proxy information.
يحول هذا الأسلوب عنوان url للوكيل إلى ProxySettings
للاستخدام مع ProxyPolicy.
إذا لم يتم إعطاء أي وسيطة، فإنها تحاول تحليل عنوان URL للوكيل من متغيرات البيئة HTTPS_PROXY
أو HTTP_PROXY
.
function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined
المعلمات
- proxyUrl
-
string
عنوان URL للوكيل المراد استخدامه. قد يحتوي على معلومات المصادقة.
المرتجعات
ProxySettings | undefined
isRestError(unknown)
Typeguard ل RestError
function isRestError(e: unknown): e
المعلمات
- e
-
unknown
شيء ما تم التقاطه بواسطة عبارة catch.
المرتجعات
e
logPolicy(LogPolicyOptions)
نهج يسجل جميع الطلبات والاستجابات.
function logPolicy(options?: LogPolicyOptions): PipelinePolicy
المعلمات
- options
- LogPolicyOptions
خيارات لتكوين logPolicy.
المرتجعات
multipartPolicy()
نهج البنية الأساسية لبرنامج ربط العمليات التجارية للطلبات متعددة الأقسام
function multipartPolicy(): PipelinePolicy
المرتجعات
ndJsonPolicy()
ndJsonPolicy هو نهج يستخدم للتحكم في إعدادات الاحتفاظ بالحيوية لكل طلب.
function ndJsonPolicy(): PipelinePolicy
المرتجعات
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })
نهج يسمح لأحد بتطبيق إعدادات الوكيل على جميع الطلبات. إذا لم يتم تمرير الإعدادات الثابتة، استردادها من متغيرات البيئة HTTPS_PROXY أو HTTP_PROXY.
function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): PipelinePolicy
المعلمات
- proxySettings
- ProxySettings
ProxySettings لاستخدامها في كل طلب.
- options
-
{ customNoProxyList?: string[] }
إعدادات إضافية، على سبيل المثال، أنماط NO_PROXY مخصصة
المرتجعات
redirectPolicy(RedirectPolicyOptions)
نهج لمتابعة عناوين الموقع من الخادم لدعم إعادة التوجيه من جانب الخادم. في المستعرض، لا يتم استخدام هذا النهج.
function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy
المعلمات
- options
- RedirectPolicyOptions
خيارات للتحكم في سلوك النهج.
المرتجعات
retryPolicy(RetryStrategy[], RetryPolicyOptions)
retryPolicy هو نهج عام لتمكين طلبات إعادة المحاولة عند استيفاء شروط معينة
function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy
المعلمات
- strategies
- options
- RetryPolicyOptions
المرتجعات
setClientRequestIdPolicy(string)
يحصل كل PipelineRequest على معرف فريد عند الإنشاء. يمرر هذا النهج هذا المعرف الفريد عبر عنوان HTTP لتمكين بيانات تتبع الاستخدام والتتبع بشكل أفضل.
function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy
المعلمات
- requestIdHeaderName
-
string
اسم العنوان لتمرير معرف الطلب إليه.
المرتجعات
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)
نهج إعادة المحاولة الذي يسعى خصيصا لمعالجة الأخطاء في طبقة النقل الأساسية (على سبيل المثال، فشل بحث DNS) بدلا من رموز الخطأ القابلة لإعادة المحاولة من الخادم نفسه.
function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy
المعلمات
- options
- SystemErrorRetryPolicyOptions
الخيارات التي تقوم بتخصيص النهج.
المرتجعات
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)
نهج يعيد المحاولة عندما يرسل الخادم استجابة 429 مع عنوان Retry-After.
لمعرفة المزيد، يرجى الرجوع إلى https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitshttps://learn.microsoft.com/en-us/azure/azure-subscription-service-limitshttps://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy
المعلمات
- options
- ThrottlingRetryPolicyOptions
الخيارات التي تقوم بتكوين منطق إعادة المحاولة.
المرتجعات
tlsPolicy(TlsSettings)
يحصل على نهج البنية الأساسية لبرنامج ربط العمليات التجارية الذي يضيف شهادة العميل إلى عامل HttpClient للمصادقة.
function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy
المعلمات
- tlsSettings
- TlsSettings
المرتجعات
tracingPolicy(TracingPolicyOptions)
نهج بسيط لإنشاء OpenTelemetry Spans لكل طلب يتم إجراؤه بواسطة البنية الأساسية لبرنامج ربط العمليات التجارية التي تحتوي على SpanOptions مع أصل. لن يتم تسجيل الطلبات التي تم إجراؤها بدون نطاق أصل.
function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy
المعلمات
- options
- TracingPolicyOptions
خيارات لتكوين بيانات تتبع الاستخدام التي تم تسجيلها بواسطة نهج التتبع.
المرتجعات
userAgentPolicy(UserAgentPolicyOptions)
نهج يعين عنوان User-Agent (أو ما يعادله) ليعكس إصدار المكتبة.
function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy
المعلمات
- options
- UserAgentPolicyOptions
خيارات لتخصيص قيمة عامل المستخدم.