MsalException クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
トークンの取得中にエラーが発生したときにスローされる基本例外の種類。 詳細については、https://aka.ms/msal-net-exceptions をご覧ください
public class MsalException : Exceptiontype MsalException = class
inherit ExceptionPublic Class MsalException
Inherits Exception- 継承
-
MsalException
- 派生
注釈
この例外はスローしないでください。 代わりに、より特殊な MsalClientException や MsalServiceException
コンストラクター
| Name | 説明 |
|---|---|
| MsalException() |
例外クラスの新しいインスタンスを初期化します。 |
| MsalException(String, String, Exception) |
指定したエラー コードと、この例外の原因である内部例外への参照を使用して、例外クラスの新しいインスタンスを初期化します。 |
| MsalException(String, String) |
指定したエラー コードとエラー メッセージを使用して、例外クラスの新しいインスタンスを初期化します。 |
| MsalException(String) |
指定したエラー コードを使用して、例外クラスの新しいインスタンスを初期化します。 |
フィールド
| Name | 説明 |
|---|---|
| AuthenticationResultMetadataKey |
MsalException以外でトークンの取得が失敗したときに MSAL がキャプチャしたAuthenticationResultMetadataを格納するDataのキー。 ダウンストリーム コンシューマーが、元の例外が変更されずに再スローされた場合でも、トークン取得診断を表示できるようにします。 |
| BrokerErrorCode |
AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。 |
| BrokerErrorContext |
AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。 |
| BrokerErrorStatus |
AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。 |
| BrokerErrorTag |
AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。 |
| BrokerTelemetry |
AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。 |
| ManagedIdentitySource |
AdditionalExceptionData プロパティ キー。マネージド ID を使用する場合に使用できます。 |
プロパティ
| Name | 説明 |
|---|---|
| AdditionalExceptionData |
この例外の詳細が含まれたプロパティ バッグ。 |
| AuthenticationResultMetadata |
失敗したトークン取得試行の診断メタデータ - 合計期間と、関連するステージが実行されたとき、HTTP/キャッシュ期間、トークン エンドポイント、および使用されるリージョン。 これは、要求パイプラインがメタデータの収集を開始する前に例外がスローされたときに |
| CorrelationId |
1 つの認証フローを分割するために使用できる ID。 |
| ErrorCode |
サービスによって返されるか、クライアントによって生成されたプロトコル エラー コードを取得します。 これは、例外処理に依存できるコードです。 このコードの値は、通常、軽減策の説明を含む派生例外型の定数文字列で提供されます。 |
| IsRetryable |
この例外が発生した前の操作を再試行する必要があるかどうかを示します。 |
メソッド
| Name | 説明 |
|---|---|
| FromJsonString(String) |
ToJsonString() によって生成された JSON からの MsalException (またはその派生型のいずれか) の再ハイドレートを許可します。 |
| ToJsonString() |
例外のほとんどの値を JSON にシリアル化できます。 |
| ToString() |
現在の例外の文字列形式を作成して返します。 |