Utility class

エージェントのランタイム操作用のヘルパー メソッドを提供するユーティリティ クラス。

メソッド

getAgentIdFromToken(string)

警告: 署名検証なし - このメソッドは、トークン署名を検証しない jwt.decode() を使用します。 トークン要求は、悪意のあるアクターによってスプーフィングされる可能性があります。 この方法は、ログ記録、分析、診断にのみ適しています。 戻り値は、承認、アクセス制御、またはセキュリティの決定には使用しないでください。

トークンをデコードし、使用可能な最適なエージェント識別子を取得します。 xms_par_app_azp (エージェント ブループリント ID) > appid > azp) の優先順位で要求を確認します。

注: 空または不足しているトークンの空の文字列を返します (既定の GUID を返す GetAppIdFromToken とは異なります)。 これにより、識別子が使用できない場合、呼び出し元はヘッダーを省略できます。

GetAppIdFromToken(string)

警告: 署名検証なし - このメソッドは、トークン署名を検証しない jwt.decode() を使用します。 トークン要求は、悪意のあるアクターによってスプーフィングされる可能性があります。 この方法は、ログ記録、分析、診断にのみ適しています。 戻り値は、承認、アクセス制御、またはセキュリティの決定には使用しないでください。

現在のトークンをデコードし、アプリ ID (appid または azp 要求) を取得します。

注: 有効な GUID が必要な呼び出し元との下位互換性のために、空のトークンの既定の GUID ('00000000-0000-0000-00000000000') を返します。 空の文字列が優先されるエージェントの識別には、 getAgentIdFromToken を使用します。

getApplicationName()

環境変数または package.jsonからアプリケーション名npm_package_name取得します。 package.json 結果は、要求中の同期 I/O を回避するために、モジュールの読み込み時にキャッシュされます。

GetUserAgentHeader(string)

SDK のバージョン、OS の種類、Node.js バージョン、オーケストレーターを含む User-Agent ヘッダー文字列を生成します。

ResolveAgentIdentity(TurnContext, string)

ターン コンテキストまたは認証トークンからエージェント ID を解決します。

メソッドの詳細

getAgentIdFromToken(string)

警告: 署名検証なし - このメソッドは、トークン署名を検証しない jwt.decode() を使用します。 トークン要求は、悪意のあるアクターによってスプーフィングされる可能性があります。 この方法は、ログ記録、分析、診断にのみ適しています。 戻り値は、承認、アクセス制御、またはセキュリティの決定には使用しないでください。

トークンをデコードし、使用可能な最適なエージェント識別子を取得します。 xms_par_app_azp (エージェント ブループリント ID) > appid > azp) の優先順位で要求を確認します。

注: 空または不足しているトークンの空の文字列を返します (既定の GUID を返す GetAppIdFromToken とは異なります)。 これにより、識別子が使用できない場合、呼び出し元はヘッダーを省略できます。

static function getAgentIdFromToken(token: string): string

パラメーター

token

string

デコードする JWT トークン

返品

string

エージェント ID (GUID) または空の文字列が見つからない場合、またはトークンが空の場合

GetAppIdFromToken(string)

警告: 署名検証なし - このメソッドは、トークン署名を検証しない jwt.decode() を使用します。 トークン要求は、悪意のあるアクターによってスプーフィングされる可能性があります。 この方法は、ログ記録、分析、診断にのみ適しています。 戻り値は、承認、アクセス制御、またはセキュリティの決定には使用しないでください。

現在のトークンをデコードし、アプリ ID (appid または azp 要求) を取得します。

注: 有効な GUID が必要な呼び出し元との下位互換性のために、空のトークンの既定の GUID ('00000000-0000-0000-00000000000') を返します。 空の文字列が優先されるエージェントの識別には、 getAgentIdFromToken を使用します。

static function GetAppIdFromToken(token: string): string

パラメーター

token

string

デコードするトークン

返品

string

AppId、または空のトークンの既定の GUID、デコードが失敗した場合は空の文字列

getApplicationName()

環境変数または package.jsonからアプリケーション名npm_package_name取得します。 package.json 結果は、要求中の同期 I/O を回避するために、モジュールの読み込み時にキャッシュされます。

static function getApplicationName(): undefined | string

返品

undefined | string

アプリケーション名。使用できない場合は未定義です。

GetUserAgentHeader(string)

SDK のバージョン、OS の種類、Node.js バージョン、オーケストレーターを含む User-Agent ヘッダー文字列を生成します。

static function GetUserAgentHeader(orchestrator?: string): string

パラメーター

orchestrator

string

User-Agent 文字列に含める省略可能なオーケストレーター識別子。

返品

string

ヘッダー文字列 User-Agent 書式設定されています。

ResolveAgentIdentity(TurnContext, string)

ターン コンテキストまたは認証トークンからエージェント ID を解決します。

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

パラメーター

context
TurnContext

ターンのターン コンテキスト。

authToken

string

使用可能な場合は認証トークン。

返品

string

エージェント ID (アプリ ID)