Utility class

คลาสยูทิลิตี้ที่มีวิธีการช่วยเหลือสําหรับการดําเนินการรันไทม์ตัวแทน

วิธีการ

getAgentIdFromToken(string)

คําเตือน: ไม่มี SIGNATURE VERIFICATION - วิธีนี้ใช้ jwt.decode() ซึ่งไม่ได้ตรวจสอบลายเซ็นของโทเค็น การอ้างสิทธิ์โทเค็นสามารถหลอกลวงได้โดยนักแสดงที่เป็นอันตราย วิธีนี้เหมาะสําหรับการบันทึก การวิเคราะห์ และการวินิจฉัยเท่านั้น อย่าใช้ค่าที่ส่งคืนสําหรับการอนุญาต การควบคุมการเข้าถึง หรือการตัดสินใจด้านความปลอดภัย

ถอดรหัสโทเค็น และเรียกใช้ตัวระบุตัวแทนที่พร้อมใช้งานที่ดีที่สุด ตรวจสอบการอ้างสิทธิ์ตามลําดับลําดับความสําคัญ: azp xms_par_app_azp (รหัสพิมพ์เขียวตัวแทน) >>

หมายเหตุ: ส่งกลับสตริงว่างสําหรับโทเค็นที่ว่างเปล่า/หายไป (ไม่เหมือนกับ GetAppIdFromToken ซึ่งส่งกลับ GUID ค่าเริ่มต้น) ซึ่งช่วยให้ผู้เรียกละเว้นส่วนหัวเมื่อไม่มีตัวระบุ

GetAppIdFromToken(string)

คําเตือน: ไม่มี SIGNATURE VERIFICATION - วิธีนี้ใช้ jwt.decode() ซึ่งไม่ได้ตรวจสอบลายเซ็นของโทเค็น การอ้างสิทธิ์โทเค็นสามารถหลอกลวงได้โดยนักแสดงที่เป็นอันตราย วิธีนี้เหมาะสําหรับการบันทึก การวิเคราะห์ และการวินิจฉัยเท่านั้น อย่าใช้ค่าที่ส่งคืนสําหรับการอนุญาต การควบคุมการเข้าถึง หรือการตัดสินใจด้านความปลอดภัย

ถอดรหัสโทเค็นปัจจุบันและเรียกใช้ ID แอป (การอ้างสิทธิ์ appid หรือ azp)

หมายเหตุ: ส่งกลับ GUID ค่าเริ่มต้น ('0000000-0000-0000-0000-00000000000') สําหรับโทเค็นว่างสําหรับความเข้ากันได้ย้อนหลังกับผู้เรียกที่คาดว่าจะมี 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)

คําเตือน: ไม่มี SIGNATURE VERIFICATION - วิธีนี้ใช้ jwt.decode() ซึ่งไม่ได้ตรวจสอบลายเซ็นของโทเค็น การอ้างสิทธิ์โทเค็นสามารถหลอกลวงได้โดยนักแสดงที่เป็นอันตราย วิธีนี้เหมาะสําหรับการบันทึก การวิเคราะห์ และการวินิจฉัยเท่านั้น อย่าใช้ค่าที่ส่งคืนสําหรับการอนุญาต การควบคุมการเข้าถึง หรือการตัดสินใจด้านความปลอดภัย

ถอดรหัสโทเค็น และเรียกใช้ตัวระบุตัวแทนที่พร้อมใช้งานที่ดีที่สุด ตรวจสอบการอ้างสิทธิ์ตามลําดับลําดับความสําคัญ: azp xms_par_app_azp (รหัสพิมพ์เขียวตัวแทน) >>

หมายเหตุ: ส่งกลับสตริงว่างสําหรับโทเค็นที่ว่างเปล่า/หายไป (ไม่เหมือนกับ GetAppIdFromToken ซึ่งส่งกลับ GUID ค่าเริ่มต้น) ซึ่งช่วยให้ผู้เรียกละเว้นส่วนหัวเมื่อไม่มีตัวระบุ

static function getAgentIdFromToken(token: string): string

พารามิเตอร์

token

string

โทเค็น JWT ที่จะถอดรหัส

การส่งคืน

string

ID ตัวแทน (GUID) หรือสตริงว่างถ้าไม่พบหรือโทเค็นว่างเปล่า

GetAppIdFromToken(string)

คําเตือน: ไม่มี SIGNATURE VERIFICATION - วิธีนี้ใช้ jwt.decode() ซึ่งไม่ได้ตรวจสอบลายเซ็นของโทเค็น การอ้างสิทธิ์โทเค็นสามารถหลอกลวงได้โดยนักแสดงที่เป็นอันตราย วิธีนี้เหมาะสําหรับการบันทึก การวิเคราะห์ และการวินิจฉัยเท่านั้น อย่าใช้ค่าที่ส่งคืนสําหรับการอนุญาต การควบคุมการเข้าถึง หรือการตัดสินใจด้านความปลอดภัย

ถอดรหัสโทเค็นปัจจุบันและเรียกใช้ ID แอป (การอ้างสิทธิ์ appid หรือ azp)

หมายเหตุ: ส่งกลับ GUID ค่าเริ่มต้น ('0000000-0000-0000-0000-00000000000') สําหรับโทเค็นว่างสําหรับความเข้ากันได้ย้อนหลังกับผู้เรียกที่คาดว่าจะมี 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

ข้อมูลประจําตัวของเจ้าหน้าที่ (ID แอป)