Utility class

חבילה:

@microsoft/agents-a365-runtime

מחלקת כלי שירות המספקת שיטות עוזרות עבור פעולות זמן ריצה של סוכן.

שיטות

getAgentIdFromToken(string)	אזהרה: אין אימות חתימה - שיטה זו משתמשת ב- jwt.decode() שאינו מאמת את חתימת האסימון. תביעות האסימון יכולות להיות מתחזות על-ידי שחקנים זדוניים. שיטה זו מתאימה רק למטרות רישום, ניתוח ואבחון. אל תשתמש בערך המוחזר לצורך הרשאה, בקרת גישה או החלטות אבטחה. מפענח את האסימון ואחזר את מזהה הסוכן הזמין הטוב ביותר. בדיקת דרישות בסדר עדיפות: xms_par_app_azp (מזהה שרטוט סוכן) > appid > azp. הערה: החזרת מחרוזת ריקה עבור אסימונים ריקים/חסרים (בשונה מ- GetAppIdFromToken , שמחזירה GUID המהווה ברירת מחדל). פעולה זו מאפשרת מתקשרים להשמיט כותרות כאשר אין מזהה זמין.
GetAppIdFromToken(string)	אזהרה: אין אימות חתימה - שיטה זו משתמשת ב- jwt.decode() שאינו מאמת את חתימת האסימון. תביעות האסימון יכולות להיות מתחזות על-ידי שחקנים זדוניים. שיטה זו מתאימה רק למטרות רישום, ניתוח ואבחון. אל תשתמש בערך המוחזר לצורך הרשאה, בקרת גישה או החלטות אבטחה. מפענח את האסימון הנוכחי ואחזר את מזהה היישום (דרישת appid או azp). הערה: החזרת GUID ברירת מחדל ('00000000-0000-0000-0000-000000000000') עבור אסימונים ריקים לצורך תאימות לאחור עם מתקשרים המצפים ל- GUID חוקי נראה חוקי. עבור זיהוי סוכן שבו מועדף מחרוזת ריקה, השתמש ב- getAgentIdFromToken.
getApplicationName()	מקבל את שם היישום ממשתנה npm_package_name סביבה או מ- package.json. התוצאה package.json מאוחסנת במטמון בזמן טעינת מודול כדי להימנע מסינכרון של I/O במהלך בקשות.
GetUserAgentHeader(string)	יוצר מחרוזת User-Agent המכילה גירסת SDK, סוג מערכת הפעלה, Node.js גירסה ו- orchestrator.
ResolveAgentIdentity(TurnContext, string)	פותר את זהות הסוכן מההקשר של השינוי או אסימון האימות.

פרטי פעולת השירות

getAgentIdFromToken(string)

אזהרה: אין אימות חתימה - שיטה זו משתמשת ב- jwt.decode() שאינו מאמת את חתימת האסימון. תביעות האסימון יכולות להיות מתחזות על-ידי שחקנים זדוניים. שיטה זו מתאימה רק למטרות רישום, ניתוח ואבחון. אל תשתמש בערך המוחזר לצורך הרשאה, בקרת גישה או החלטות אבטחה.

מפענח את האסימון ואחזר את מזהה הסוכן הזמין הטוב ביותר. בדיקת דרישות בסדר עדיפות: xms_par_app_azp (מזהה שרטוט סוכן) > appid > azp.

הערה: החזרת מחרוזת ריקה עבור אסימונים ריקים/חסרים (בשונה מ- GetAppIdFromToken , שמחזירה GUID המהווה ברירת מחדל). פעולה זו מאפשרת מתקשרים להשמיט כותרות כאשר אין מזהה זמין.

static function getAgentIdFromToken(token: string): string

פרמטרים

token

string

אסימון JWT לפענוח

החזרות

string

מזהה סוכן (GUID) או מחרוזת ריקה אם לא נמצא או האסימון ריק

GetAppIdFromToken(string)

אזהרה: אין אימות חתימה - שיטה זו משתמשת ב- jwt.decode() שאינו מאמת את חתימת האסימון. תביעות האסימון יכולות להיות מתחזות על-ידי שחקנים זדוניים. שיטה זו מתאימה רק למטרות רישום, ניתוח ואבחון. אל תשתמש בערך המוחזר לצורך הרשאה, בקרת גישה או החלטות אבטחה.

מפענח את האסימון הנוכחי ואחזר את מזהה היישום (דרישת appid או azp).

הערה: החזרת GUID ברירת מחדל ('00000000-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 מאוחסנת במטמון בזמן טעינת מודול כדי להימנע מסינכרון של I/O במהלך בקשות.

static function getApplicationName(): undefined | string

החזרות

undefined | string

שם יישום או לא מוגדר אם אינו זמין.

GetUserAgentHeader(string)

יוצר מחרוזת User-Agent המכילה גירסת SDK, סוג מערכת הפעלה, Node.js גירסה ו- orchestrator.

static function GetUserAgentHeader(orchestrator?: string): string

פרמטרים

orchestrator

string

מזהה orchestrator אופציונלי שייכלל User-Agent המחרוזת.

החזרות

string

מעוצב User-Agent כותרת עליונה.

ResolveAgentIdentity(TurnContext, string)

פותר את זהות הסוכן מההקשר של השינוי או אסימון האימות.

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

פרמטרים

context

TurnContext

העבר את הקשר ההקשר.

authToken

string

אסימון אימות אם זמין.

החזרות

string

זהות סוכן (מזהה יישום)