Utility class

فئة الأداة المساعدة التي توفر أساليب المساعد لعمليات وقت تشغيل العامل.

الأساليب

getAgentIdFromToken(string)

تحذير: NO SIGNATURE VERIFICATION - يستخدم هذا الأسلوب jwt.decode() الذي لا يتحقق من توقيع الرمز المميز. يمكن تزييف مطالبات الرمز المميز من قبل جهات ضارة. هذه الطريقة مناسبة فقط لأغراض التسجيل والتحليلات والتشخيص. لا تستخدم القيمة التي تم إرجاعها للتخويل أو التحكم في الوصول أو قرارات الأمان.

فك ترميز الرمز المميز واسترداد أفضل معرف عامل متوفر. التحقق من المطالبات بترتيب الأولوية: xms_par_app_azp (معرف مخطط العامل) > appid > azp.

ملاحظة: إرجاع سلسلة فارغة للرمز المميزة الفارغة/المفقودة (على عكس GetAppIdFromToken الذي يقوم بإرجاع GUID افتراضي). يسمح هذا للمتصلين بحذف الرؤوس عند عدم توفر معرف.

GetAppIdFromToken(string)

تحذير: NO SIGNATURE VERIFICATION - يستخدم هذا الأسلوب jwt.decode() الذي لا يتحقق من توقيع الرمز المميز. يمكن تزييف مطالبات الرمز المميز من قبل جهات ضارة. هذه الطريقة مناسبة فقط لأغراض التسجيل والتحليلات والتشخيص. لا تستخدم القيمة التي تم إرجاعها للتخويل أو التحكم في الوصول أو قرارات الأمان.

فك ترميز الرمز المميز الحالي واسترداد معرف التطبيق (appid أو مطالبة azp).

ملاحظة: إرجاع GUID افتراضي ('000000000-0000-0000-0000-000000000000') للرمز المميزة الفارغة للتوافق مع الإصدارات السابقة مع المتصلين الذين يتوقعون GUID صالح المظهر. لتحديد العامل حيث يفضل السلسلة الفارغة، استخدم getAgentIdFromToken.

getApplicationName()

يحصل على اسم التطبيق من متغير بيئة npm_package_name أو package.json. يتم تخزين النتيجة package.json مؤقتا في وقت تحميل الوحدة النمطية لتجنب مزامنة الإدخال/الإخراج أثناء الطلبات.

GetUserAgentHeader(string)

إنشاء سلسلة رأس User-Agent تحتوي على إصدار SDK ونوع نظام التشغيل وإصدار Node.js والمنسق.

ResolveAgentIdentity(TurnContext, string)

حل هوية العامل من سياق الدور أو الرمز المميز للمصادقة.

تفاصيل الأسلوب

getAgentIdFromToken(string)

تحذير: NO SIGNATURE VERIFICATION - يستخدم هذا الأسلوب jwt.decode() الذي لا يتحقق من توقيع الرمز المميز. يمكن تزييف مطالبات الرمز المميز من قبل جهات ضارة. هذه الطريقة مناسبة فقط لأغراض التسجيل والتحليلات والتشخيص. لا تستخدم القيمة التي تم إرجاعها للتخويل أو التحكم في الوصول أو قرارات الأمان.

فك ترميز الرمز المميز واسترداد أفضل معرف عامل متوفر. التحقق من المطالبات بترتيب الأولوية: xms_par_app_azp (معرف مخطط العامل) > appid > azp.

ملاحظة: إرجاع سلسلة فارغة للرمز المميزة الفارغة/المفقودة (على عكس GetAppIdFromToken الذي يقوم بإرجاع GUID افتراضي). يسمح هذا للمتصلين بحذف الرؤوس عند عدم توفر معرف.

static function getAgentIdFromToken(token: string): string

المعلمات

token

string

رمز JWT المميز لفك ترميزه

المرتجعات

string

معرف العامل (GUID) أو سلسلة فارغة إذا لم يتم العثور عليه أو كان الرمز المميز فارغا

GetAppIdFromToken(string)

تحذير: NO SIGNATURE VERIFICATION - يستخدم هذا الأسلوب jwt.decode() الذي لا يتحقق من توقيع الرمز المميز. يمكن تزييف مطالبات الرمز المميز من قبل جهات ضارة. هذه الطريقة مناسبة فقط لأغراض التسجيل والتحليلات والتشخيص. لا تستخدم القيمة التي تم إرجاعها للتخويل أو التحكم في الوصول أو قرارات الأمان.

فك ترميز الرمز المميز الحالي واسترداد معرف التطبيق (appid أو مطالبة azp).

ملاحظة: إرجاع GUID افتراضي ('000000000-0000-0000-0000-000000000000') للرمز المميزة الفارغة للتوافق مع الإصدارات السابقة مع المتصلين الذين يتوقعون GUID صالح المظهر. لتحديد العامل حيث يفضل السلسلة الفارغة، استخدم getAgentIdFromToken.

static function GetAppIdFromToken(token: string): string

المعلمات

token

string

الرمز المميز إلى فك التشفير

المرتجعات

string

AppId، أو GUID الافتراضي للرمز المميز الفارغ، أو سلسلة فارغة إذا فشل فك الترميز

getApplicationName()

يحصل على اسم التطبيق من متغير بيئة npm_package_name أو package.json. يتم تخزين النتيجة package.json مؤقتا في وقت تحميل الوحدة النمطية لتجنب مزامنة الإدخال/الإخراج أثناء الطلبات.

static function getApplicationName(): undefined | string

المرتجعات

undefined | string

اسم التطبيق أو غير معرف إذا لم يكن متوفرا.

GetUserAgentHeader(string)

إنشاء سلسلة رأس User-Agent تحتوي على إصدار SDK ونوع نظام التشغيل وإصدار Node.js والمنسق.

static function GetUserAgentHeader(orchestrator?: string): string

المعلمات

orchestrator

string

معرف منسق اختياري لتضمينه في سلسلة User-Agent.

المرتجعات

string

سلسلة رأس User-Agent منسقة.

ResolveAgentIdentity(TurnContext, string)

حل هوية العامل من سياق الدور أو الرمز المميز للمصادقة.

static function ResolveAgentIdentity(context: TurnContext, authToken: string): string

المعلمات

context
TurnContext

تحويل سياق الدور.

authToken

string

رمز المصادقة المميز إذا كان متوفرا.

المرتجعات

string

هوية العامل (معرف التطبيق)