تكوين عنوان URL للمضيف والتوجيه

  • 3 دقائق

من الاستخدامات الشائعة لقوالب السياسات هو السماح بالتكوين الديناميكي لواجهة API التي تؤدي نقطة النهاية هذه إلى تشغيلها والتي ستستخدمها الإجراءات في وقت التشغيل. تتوفر قوالب السياسات التالية:

  • تعيين عنوان URL للمضيف - يستبدل عنوان URL الكامل للمضيف بآخر تم إنشاؤه باستخدام السياسة.

  • طلب المسار - يوجه طلباً وارداً إلى نقطة نهاية معيّنة على عنوان URL المكون للمضيف.

تعيين عنوان URL للمضيف

بشكل افتراضي، يكون عنوان URL المستخدَم للمضيف مكوناً بشكل ثابت ومشابه لجميع المشغلات والإجراءات على الموصل الخاص بك. باستخدام قالب سياسة تعيين عنوان URL للمضيف‬، يمكنك تكوين عنوان URL للمشغلات والإجراءات بشكل فردي. من الأمثلة على هذا السيناريو هو أنك إذا كان لديك الإجراءات ذات الصلة بالأوامر على عنوان URL واحد (على سبيل المثال، ordersapi.contoso.com) والإجراءات ذات الصلة بالمستخدمين على آخر (على سبيل المثال، userapi.contoso.com). في هذا السيناريو، ستقوم بتكوين قالبَين للسياسة، وسيحدّد كل منهما المستخدم المناسب أو إجراءات الأمر التي يجب تطبيقها على عناوين URL المضيف الجديد.

غالباً، أكثر الاستخدامات شيوعاً هي السماح للمستخدمين بتوفير عنوان URL للمضيف في وقت التشغيل عند إنشاء اتصال جديد باستخدام الموصل المخصص، كما هو موضح سابقاً في هذه الوحدة النمطية. في هذا المثال، تمت إضافة خاصية باسم hostURL إلى التعبير connectionParameters وقدم المستخدم عنوان URL الكامل للمضيف في وقت الاتصال.

من الطرق الأخرى الشائعة لاستخدام قالب سياسة تعيين عنوان URL للمضيف هي إنشاء جزء من عنوان URL للمضيف ديناميكياً وجعل جزء منه ثابت. باستخدام هذا الأسلوب، ما على المستخدم سوى توفير اسم الحساب الخاص به أو بيانات رئيسية أخرى تشكّل عنوان URL الكامل. من الأمثلة على هذا السيناريو هو موصل Azure Key Vault، حيث إن عنوان URL للمضيف فريد لكل مخزن. بدلاً من أن تطلب من المستخدم أن يوفر عنوان URL الكامل للمخزن (https://contosokv.vault.azure.net)، يمكنك إضافة خاصية اتصال باسم keyVaultName وبعد ذلك يجب مطالبة المستخدم بتوفير هذا الجزء من عنوان URL فقط (contosokv، في هذا المثال). يعرض المثال التالي شكل قالب السياسة هذا.

لقطة شاشة لتفاصيل السياسة مع سهم يشير إلى قالب عنوان URL.

يمكنك أيضاً تضمين بيانات باستخدام التعبيرَين @headers و@queryParameters بالإضافة إلى استخدام @connectionParameters.

طلب المسار

كل إجراء على الموصل المخصص لديه عنوان URL مؤهل بالكامل (مثل https://api.contoso.com/AddInvoice) المستخدم لإجراء الطلب لواجهة API الأساسية. يأتي عنوان URL هذا من تركيبة تضم المضيف (على سبيل المثال، api.contoso.com) الذي تحدده على علامة التبويب عام والمسار (مثل /AddInvoice) الذي جاء من تعريف تم استيراده أو تم استخراجه من عينة لطلب عند إجراء عينة طلب للاستيراد. تسمح لك سياسة تعيين عنوان URL للمضيف بتعديل المضيف، ويسمح لك طلب المسار بتعديل المسار.

من السيناريوهات الأخرى التي يمكنك تنفيذها باستخدام سياسة طلب المسار هو وجود إجراءات متعددة تشير إلى المسار نفسه. على سبيل المثال، إذا كان لديك إجراء سرد الفواتير الذي أخذ fromAmount كمعلمة، وتريد إنشاء إجراء سرد الفواتير الكبيرة الذي كانت لديه قيمة افتراضية لـ fromAmount، فستحصل على رسالة خطأ بسبب إشارة كل منهما إلى المسار نفسه: /ListInvoices. بدلاً من ذلك، يمكنك تعريف إجراء سرد الفواتير الكبيرة مع مسار /ListBigInvoices، الذي لا يوجد على واجهة API. بعد ذلك، يمكنك استخدام طلب مسار لإرسال استدعاءات تلك الإجراءات هذه إلى /ListInvoices. يعرض المثال التالي شكل قالب السياسة.

لقطة شاشة حول تفاصيل السياسة تعرض الاسم والقالب والعمليات والمسار الجديد والطريقة.

يمكنك أيضاً تضمين المعلمات وغير ذلك من التعبيرات لمساعدتك على بناء المسار. على سبيل المثال، يستخدم موصل مهام Microsoft Outlook المسار الافتراضي في مجلدات القائمة في مجموعة ‪/v2/me/taskgroups('{group_id}')/taskfolders‬. باستخدام طلب المسار التالي، سيتم توجيه الطلبات إلى المسار الجديد.

لقطة شاشة حول تفاصيل السياسة تعرض الاسم والقالب والعمليات والمسار الجديد والطريقة بقيم مختلفة.

لاحظ أنه في {group_id}، أشارت الطلبات إلى أن إحدى المعلمات للإجراء مشابهة لكيفية تنفيذها في المسار الأصلي.

يمنحك استخدام قوالب سياستَي تعيين عنوان URL للمضيف وطلب المسار بعض المرونة لتوجيه الطلبات كما يلزم إلى واجهة API الأساسية.