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 αποτέλεσμα αποθηκεύεται στο cache κατά τον χρόνο φόρτωσης της εκπαιδευτικής ενότητας για να αποφεύγεται ο συγχρονισμός αναγνωριστικών/εξόδου κατά τις αιτήσεις.
GetUserAgentHeader(string)

Δημιουργεί μια συμβολοσειρά κεφαλίδας User-Agent που περιέχει έκδοση SDK, τύπο ΛΕΙΤΟΥΡΓΙΚού συστήματος, Node.js έκδοση και ενορχηστρωτή.
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 αποτέλεσμα αποθηκεύεται στο cache κατά τον χρόνο φόρτωσης της εκπαιδευτικής ενότητας για να αποφεύγεται ο συγχρονισμός αναγνωριστικών/εξόδου κατά τις αιτήσεις.

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

Ταυτότητα παράγοντα (Αναγνωριστικό εφαρμογής)