@azure-rest/core-client package

الواجهات

AddCredentialPipelinePolicyOptions	معلمات اختيارية لإضافة نهج بيانات اعتماد إلى البنية الأساسية لبرنامج ربط العمليات التجارية.
AdditionalPolicyConfig	يستخدم لتكوين نهج إضافية تمت إضافتها إلى البنية الأساسية لبرنامج ربط العمليات التجارية عند الإنشاء.
Client	شكل عميل مستوى الراحة
ErrorModel	كائن الخطأ.
ErrorResponse	استجابة تحتوي على تفاصيل الخطأ.
FullOperationResponse	كائن برنامج التضمين لطلب واستجابة http. يتم تخزين الكائن الذي تم إلغاء تسلسله في الخاصية parsedBody عند تلقي نص الاستجابة في JSON.
InnerError	كائن يحتوي على معلومات أكثر تحديدا حول الخطأ. وفقا لإرشادات واجهة برمجة تطبيقات Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
NodeJSReadableStream	دفق Node.js قابل للقراءة يحتوي أيضا على destroy أسلوب.
OperationOptions	نوع الخيارات الأساسية لكافة العمليات.
OperationRequestOptions	الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية.
PathParameterWithOptions	كائن يمكن تمريره كمعلمة مسار، ما يسمح بتعيين خيارات إضافية تتعلق بكيفية ترميز المعلمة.
ResourceMethods	تعريف الأساليب التي يمكن استدعاؤها على مورد

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

ClientOptions	الخيارات العامة التي يمكن لعميل مستوى الراحة اتخاذها
HttpBrowserStreamResponse	استجابة Http أي نص هو كائن دفق NodeJS
HttpNodeStreamResponse	استجابة Http أي نص هو كائن دفق NodeJS
HttpResponse	يمثل شكل HttpResponse
PathParameters	نوع المساعد المستخدم للكشف عن المعلمات في نص قالب مسار محاط {} سيعتبر معلمة مسار
PathUnchecked	تعريف توقيع pathUnchecked.
PathUncheckedResponse	اكتب لاستخدامه مع pathUnchecked، ويتجاوز نوع النص الأساسي إلى أي للسماح بالمرونة
RawResponseCallback	دالة سيتم استدعاؤها في كل مرة يتم فيها تلقي استجابة من الخادم أثناء تنفيذ العملية المطلوبة. قد يتم استدعاؤه عدة مرات. سيتم استدعاء رد الاتصال هذا بمعلمتين: الاستجابة الأولية، بما في ذلك الرؤوس و نص الاستجابة؛ وعنصر الخطأ الذي سيتم توفيره إذا تم طرح خطأ أثناء معالجة الطلب. يتم توفير المعلمة __legacyError الثالثة للتوافق مع الإصدارات السابقة فقط وسيكون لها قيمة مماثلة للمعلمة error.
RequestParameters	شكل معلمات الطلب الافتراضية، قد يتم تجاوز ذلك بواسطة أنواع الطلبات المحددة لتوفير أنواع قوية
StreamableMethod	يحدد نوع أسلوب يدعم الحصول على نص الاستجابة كتدفق أولي

الوظائف

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)	إضافة نهج بيانات اعتماد إلى البنية الأساسية لبرنامج ربط العمليات التجارية إذا تم توفير بيانات اعتماد. إذا لم يتم توفير أي نهج، فلن تتم إضافة أي نهج.
createRestError(PathUncheckedResponse)	إنشاء خطأ بقية من استجابة PathUnchecked
createRestError(string, PathUncheckedResponse)	إنشاء خطأ بقية من رسالة خطأ واستجابة PathUnchecked
getClient(string, ClientOptions)	إنشاء عميل بمسار افتراضي
getClient(string, TokenCredential | KeyCredential, ClientOptions)	إنشاء عميل بمسار افتراضي
operationOptionsToRequestParameters(OperationOptions)	دالة المساعد لتحويل OperationOptions إلى RequestParameters

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

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

إضافة نهج بيانات اعتماد إلى البنية الأساسية لبرنامج ربط العمليات التجارية إذا تم توفير بيانات اعتماد. إذا لم يتم توفير أي نهج، فلن تتم إضافة أي نهج.

function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions)

المعلمات

pipeline

Pipeline

endpoint

string

options

AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

إنشاء خطأ بقية من استجابة PathUnchecked

function createRestError(response: PathUncheckedResponse): RestError

المعلمات

response

PathUncheckedResponse

المرتجعات

RestError

createRestError(string, PathUncheckedResponse)

إنشاء خطأ بقية من رسالة خطأ واستجابة PathUnchecked

function createRestError(message: string, response: PathUncheckedResponse): RestError

المعلمات

message

string

response

PathUncheckedResponse

المرتجعات

RestError

getClient(string, ClientOptions)

إنشاء عميل بمسار افتراضي

function getClient(endpoint: string, options?: ClientOptions): Client

المعلمات

endpoint

string

نقطة النهاية الأساسية للعميل

options

ClientOptions

خيارات العميل

المرتجعات

Client

getClient(string, TokenCredential | KeyCredential, ClientOptions)

إنشاء عميل بمسار افتراضي

function getClient(endpoint: string, credentials?: TokenCredential | KeyCredential, options?: ClientOptions): Client

المعلمات

endpoint

string

نقطة النهاية الأساسية للعميل

credentials

TokenCredential | KeyCredential

بيانات الاعتماد لمصادقة الطلبات

options

ClientOptions

خيارات العميل

المرتجعات

Client

operationOptionsToRequestParameters(OperationOptions)

دالة المساعد لتحويل OperationOptions إلى RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

المعلمات

options

OperationOptions

الخيارات التي تستخدمها الطبقة النمطية لإرسال الطلب

المرتجعات

RequestParameters

نتيجة التحويل في RequestParameters لطبقة RLC