@azure/core-client package
الفصول
ServiceClient |
تهيئة مثيل جديد من ServiceClient. |
الواجهات
AdditionalPolicyConfig |
يستخدم لتكوين نهج إضافية تمت إضافتها إلى البنية الأساسية لبرنامج ربط العمليات التجارية عند الإنشاء. |
BaseMapper |
التعريف الأساسي للمخطط. يمكن استخدامها لعناصر XML وJavaScript العادية. |
CommonClientOptions |
من المتوقع أن تعرض المجموعة الشائعة من الخيارات التي من المتوقع أن يعرضها العملاء عاليو المستوى. |
CompositeMapper |
معين يتكون من معينين آخرين. |
CompositeMapperType |
يساعد في إنشاء معين يصف كيفية تعيين مجموعة من خصائص كائن استنادا إلى معينين آخرين. يجب أن تكون إحدى الخصائص التالية موجودة فقط: |
DeserializationContentTypes |
أنواع المحتوى التي تشير إلى أنه يجب إلغاء تسلسل استجابة العملية بطريقة معينة. |
DeserializationPolicyOptions |
خيارات لتكوين إلغاء تسلسل استجابة واجهة برمجة التطبيقات. |
DictionaryMapper |
مخطط يصف كائنات JavaScript العادية المستخدمة كأزواج مفاتيح/قيمة. |
DictionaryMapperType |
يساعد في إنشاء معين يصف كيفية تحليل قاموس القيم المعينة. |
EnumMapper |
معين يصف قيمة قائمة تعداد. |
EnumMapperType |
يساعد في إنشاء معين يصف كيفية تحليل قيمة قائمة تعداد. |
FullOperationResponse |
كائن برنامج التضمين لطلب واستجابة http. يتم تخزين الكائن الذي تم إلغاء تسلسله في الخاصية |
InternalClientPipelineOptions |
خيارات لإنشاء مسار لاستخدامه مع ServiceClient. غالبا لتخصيص نهج المصادقة (إذا كنت تستخدم مصادقة الرمز المميز) أو خيارات إلغاء التسلسل عند استخدام XML. |
MapperConstraints |
وصف قيود القيمة المختلفة مثل نطاقات الأعداد الصحيحة وسلسلة regex. |
OperationArguments |
مجموعة من الخصائص التي تنطبق على استدعاء واحد لعملية. |
OperationOptions |
نوع الخيارات الأساسية لكافة العمليات. |
OperationParameter |
واجهة شائعة تقوم كافة معلمة العملية بتوسيعها. |
OperationQueryParameter |
معلمة لعملية ستتم إضافتها كمعلمة استعلام إلى طلب HTTP الخاص بالعملية. |
OperationRequestInfo |
بيانات التعريف المستخدمة لتحليل استجابة بشكل صحيح. |
OperationRequestOptions |
الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية. |
OperationResponseMap |
OperationResponse الذي يمكن إرجاعه من طلب عملية لرمز حالة واحد. |
OperationSpec |
مواصفات تحدد عملية. |
OperationURLParameter |
معلمة لعملية سيتم استبدالها في عنوان URL لطلب العملية. |
PolymorphicDiscriminator |
تستخدم لإزالة الغموض عن اتحادات النوع التمييزي. على سبيل المثال، إذا كان يمكن أن تحتوي الاستجابة على العديد من الأشكال ولكنها تتضمن أيضا حقل "نوع" (أو ما شابه ذلك)، يمكن استخدام هذا الحقل لتحديد كيفية إلغاء تسلسل الاستجابة إلى النوع الصحيح. |
SequenceMapper |
معين يصف الصفائف. |
SequenceMapperType |
يساعد في إنشاء معين يصف كيفية توزيع تسلسل من القيم المعينة. |
SerializationPolicyOptions |
خيارات لتكوين تسلسل طلب واجهة برمجة التطبيقات. |
Serializer |
يستخدم لتعيين كائنات الاستجابة الأولية إلى الأشكال النهائية. يساعد على تعبئة التواريخ وفك حزمها والأنواع الأخرى المشفرة التي ليست مضمنة في JSON. يسمح أيضا بسحب القيم من الرؤوس، بالإضافة إلى إدراج القيم والثوابت الافتراضية. |
SerializerOptions |
خيارات لتكوين سلوك التسلسل/إلغاء التسلسل. |
ServiceClientOptions |
الخيارات التي سيتم توفيرها أثناء إنشاء العميل. |
SimpleMapperType |
نوع معين بسيط. |
SpanConfig |
تكوين لإنشاء امتداد تتبع جديد |
XmlOptions |
خيارات لتنظيم سلوك محلل xml ومنشئه. |
النوع أسماء مستعارة
Mapper |
Mappers هي تعريفات لنماذج البيانات المستخدمة في المكتبة. نماذج البيانات هذه هي جزء من تعريفات العملية أو العميل في الاستجابات أو المعلمات. |
MapperType |
نوع المعين. يتضمن المخططين المعروفين. |
OperationRequest |
اسم مستعار للنوع للتدقيق المستقبلي. |
ParameterPath |
ترميز كيفية الوصول إلى خاصية معينة على كائن. |
QueryCollectionFormat |
التنسيق الذي سيتم استخدامه لضم صفيف من القيم معا لقيمة معلمة استعلام. |
RawResponseCallback |
دالة سيتم استدعاؤها في كل مرة يتم فيها تلقي استجابة من الخادم أثناء تنفيذ العملية المطلوبة. قد يتم استدعاؤه عدة مرات. |
الوظائف
authorize |
يمكن استخدام هذه الدالة كرد اتصال اتصل
بمجرد توفيرها، سيتعامل نهج مثال على الطعن في المطالبات:
|
authorize |
يحدد رد الاتصال للتعامل مع تحدي المصادقة لواجهات برمجة تطبيقات التخزين. هذا ينفذ عملية تحدي الحامل الموضحة هنا: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge معالجة لها ميزات محددة للتخزين الذي يغادر إلى مستندات تحدي AAD العامة. |
create |
إنشاء مسار جديد للاستخدام مع عميل الخدمة. يضيف في إلغاء التسلسلPolicy بشكل افتراضي. يضيف أيضا في bearerTokenAuthenticationPolicy إذا تم تمرير TokenCredential. |
create |
الأسلوب الذي يقوم بإنشاء جهاز تسلسل وإرجاعه. |
deserialization |
يعالج هذا النهج تحليل الاستجابات وفقا ل OperationSpecs عند الطلب. |
serialization |
يعالج هذا النهج تجميع نص الطلب والعناوين باستخدام OperationSpec و OperationArguments عند الطلب. |
تفاصيل الوظيفة
authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)
يمكن استخدام هذه الدالة كرد اتصال bearerTokenAuthenticationPolicy
@azure/core-rest-pipeline
، لدعم تحديات CAE: تقييم الوصول المستمر.
اتصل bearerTokenAuthenticationPolicy
بالخيارات التالية:
import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";
const policy = bearerTokenAuthenticationPolicy({
challengeCallbacks: {
authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge,
},
scopes: ["https://service/.default"],
});
بمجرد توفيرها، سيتعامل نهج bearerTokenAuthenticationPolicy
داخليا مع تحديات تقييم الوصول المستمر (CAE).
عندما لا يتمكن من إكمال تحدي، فإنه سيعيد استجابة 401 (غير مصرح به) من ARM.
مثال على الطعن في المطالبات:
Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token",
error_description="User session has been revoked",
claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="
function authorizeRequestOnClaimChallenge(onChallengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>
المعلمات
- onChallengeOptions
- AuthorizeRequestOnChallengeOptions
المرتجعات
Promise<boolean>
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)
يحدد رد الاتصال للتعامل مع تحدي المصادقة لواجهات برمجة تطبيقات التخزين. هذا ينفذ عملية تحدي الحامل الموضحة هنا: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge معالجة لها ميزات محددة للتخزين الذي يغادر إلى مستندات تحدي AAD العامة.
function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>
المعلمات
- challengeOptions
- AuthorizeRequestOnChallengeOptions
المرتجعات
Promise<boolean>
createClientPipeline(InternalClientPipelineOptions)
إنشاء مسار جديد للاستخدام مع عميل الخدمة. يضيف في إلغاء التسلسلPolicy بشكل افتراضي. يضيف أيضا في bearerTokenAuthenticationPolicy إذا تم تمرير TokenCredential.
function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline
المعلمات
- options
- InternalClientPipelineOptions
خيارات لتخصيص البنية الأساسية لبرنامج ربط العمليات التجارية التي تم إنشاؤها.
المرتجعات
createSerializer({[key: string]: any}, boolean)
الأسلوب الذي يقوم بإنشاء جهاز تسلسل وإرجاعه.
function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): Serializer
المعلمات
- modelMappers
-
{[key: string]: any}
النماذج المعروفة المراد تعيينها
- isXML
-
boolean
إذا كان يجب دعم XML
المرتجعات
deserializationPolicy(DeserializationPolicyOptions)
يعالج هذا النهج تحليل الاستجابات وفقا ل OperationSpecs عند الطلب.
function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy
المعلمات
- options
- DeserializationPolicyOptions
المرتجعات
serializationPolicy(SerializationPolicyOptions)
يعالج هذا النهج تجميع نص الطلب والعناوين باستخدام OperationSpec و OperationArguments عند الطلب.
function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy
المعلمات
- options
- SerializationPolicyOptions