@azure-rest/core-client package
الواجهات
AddCredentialPipelinePolicyOptions |
معلمات اختيارية لإضافة نهج بيانات اعتماد إلى البنية الأساسية لبرنامج ربط العمليات التجارية. |
AdditionalPolicyConfig |
يستخدم لتكوين نهج إضافية تمت إضافتها إلى البنية الأساسية لبرنامج ربط العمليات التجارية عند الإنشاء. |
Client |
شكل عميل مستوى الراحة |
ErrorModel |
كائن الخطأ. |
ErrorResponse |
استجابة تحتوي على تفاصيل الخطأ. |
FullOperationResponse |
كائن برنامج التضمين لطلب http والاستجابة. يتم تخزين الكائن الذي تم إلغاء تسلسله في الخاصية |
InnerError |
كائن يحتوي على معلومات أكثر تحديدا حول الخطأ. وفقا لإرشادات واجهة برمجة تطبيقات Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
OperationOptions |
نوع الخيارات الأساسية لجميع العمليات. |
OperationRequestOptions |
الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية. |
ResourceMethods |
يحدد الأساليب التي يمكن استدعاؤها على مورد |
النوع أسماء مستعارة
ClientOptions |
الخيارات العامة التي يمكن للعميل على مستوى الراحة اتخاذها |
HttpBrowserStreamResponse |
استجابة Http أي نص هو كائن دفق NodeJS |
HttpNodeStreamResponse |
استجابة Http أي نص هو كائن دفق NodeJS |
HttpResponse |
يمثل شكل HttpResponse |
PathParameters |
سيتم اعتبار نوع المساعد المستخدم للكشف عن المعلمات في نص قالب مسار محاط {} بمعلمة مسار |
PathUnchecked |
يحدد توقيع pathUnchecked. |
PathUncheckedResponse |
اكتب لاستخدامه مع pathUnchecked، ويتجاوز نوع النص الأساسي إلى أي للسماح بالمرونة |
RawResponseCallback |
دالة سيتم استدعاؤها في كل مرة يتم فيها تلقي استجابة من الخادم أثناء تنفيذ العملية المطلوبة. قد يتم استدعاؤه عدة مرات. |
RequestParameters |
شكل معلمات الطلب الافتراضية، قد يتم تجاوز ذلك بواسطة أنواع الطلبات المحددة لتوفير أنواع قوية |
StreamableMethod |
يحدد نوع أسلوب يدعم الحصول على نص الاستجابة كتدفق أولي |
الوظائف
add |
يضيف نهج بيانات اعتماد إلى البنية الأساسية لبرنامج ربط العمليات التجارية إذا تم توفير بيانات اعتماد. إذا لم يتم توفير أي منها، فلن تتم إضافة أي نهج. |
create |
إنشاء خطأ بقية من استجابة PathUnchecked |
create |
إنشاء خطأ بقية من رسالة خطأ واستجابة PathUnchecked |
get |
إنشاء عميل بمسار افتراضي |
get |
إنشاء عميل بمسار افتراضي |
operation |
وظيفة المساعد لتحويل OperationOptions إلى RequestParameters |
تفاصيل الوظيفة
addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)
يضيف نهج بيانات اعتماد إلى البنية الأساسية لبرنامج ربط العمليات التجارية إذا تم توفير بيانات اعتماد. إذا لم يتم توفير أي منها، فلن تتم إضافة أي نهج.
function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions)
المعلمات
- pipeline
- Pipeline
- endpoint
-
string
createRestError(PathUncheckedResponse)
إنشاء خطأ بقية من استجابة PathUnchecked
function createRestError(response: PathUncheckedResponse): RestError
المعلمات
- response
- PathUncheckedResponse
المرتجعات
createRestError(string, PathUncheckedResponse)
إنشاء خطأ بقية من رسالة خطأ واستجابة PathUnchecked
function createRestError(message: string, response: PathUncheckedResponse): RestError
المعلمات
- message
-
string
- response
- PathUncheckedResponse
المرتجعات
getClient(string, ClientOptions)
إنشاء عميل بمسار افتراضي
function getClient(endpoint: string, options?: ClientOptions): Client
المعلمات
- endpoint
-
string
نقطة النهاية الأساسية للعميل
- options
- ClientOptions
خيارات العميل
المرتجعات
getClient(string, TokenCredential | KeyCredential, ClientOptions)
إنشاء عميل بمسار افتراضي
function getClient(endpoint: string, credentials?: TokenCredential | KeyCredential, options?: ClientOptions): Client
المعلمات
- endpoint
-
string
نقطة النهاية الأساسية للعميل
- credentials
بيانات الاعتماد لمصادقة الطلبات
- options
- ClientOptions
خيارات العميل
المرتجعات
operationOptionsToRequestParameters(OperationOptions)
وظيفة المساعد لتحويل OperationOptions إلى RequestParameters
function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters
المعلمات
- options
- OperationOptions
الخيارات التي تستخدمها الطبقة النمطية لإرسال الطلب
المرتجعات
نتيجة التحويل في RequestParameters لطبقة RLC