Language

MsalClientException クラス

定義

この例外クラスは、ライブラリまたはデバイスに対してローカルなエラーを表します。 Azure AD サービスまたはネットワークから発生するエラーを表すMsalServiceExceptionとは対照的です。 詳細については、https://aka.ms/msal-net-exceptions をご覧ください

public class MsalClientException : Microsoft.Identity.Client.MsalException
type MsalClientException = class
    inherit MsalException
Public Class MsalClientException
Inherits MsalException
継承
MsalClientException

コンストラクター

Name 説明
MsalClientException(String, String, Exception)

指定したエラー コード、エラー メッセージ、および内部例外を使用して、例外クラスの新しいインスタンスを初期化します。

MsalClientException(String, String)

指定したエラー コードとエラー メッセージを使用して、例外クラスの新しいインスタンスを初期化します。

MsalClientException(String)

指定したエラー コードを使用して、例外クラスの新しいインスタンスを初期化します。

フィールド

Name 説明
AuthenticationResultMetadataKey

MsalException以外でトークンの取得が失敗したときに MSAL がキャプチャしたAuthenticationResultMetadataを格納するDataのキー。 ダウンストリーム コンシューマーが、元の例外が変更されずに再スローされた場合でも、トークン取得診断を表示できるようにします。

(継承元 MsalException)
BrokerErrorCode

AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。

(継承元 MsalException)
BrokerErrorContext

AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。

(継承元 MsalException)
BrokerErrorStatus

AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。

(継承元 MsalException)
BrokerErrorTag

AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。

(継承元 MsalException)
BrokerTelemetry

AdditionalExceptionData プロパティ キー。デスクトップ ブローカーを使用する場合に使用できます。

(継承元 MsalException)
ManagedIdentitySource

AdditionalExceptionData プロパティ キー。マネージド ID を使用する場合に使用できます。

(継承元 MsalException)

プロパティ

Name 説明
AdditionalExceptionData

この例外の詳細が含まれたプロパティ バッグ。

(継承元 MsalException)
AuthenticationResultMetadata

失敗したトークン取得試行の診断メタデータ - 合計期間と、関連するステージが実行されたとき、HTTP/キャッシュ期間、トークン エンドポイント、および使用されるリージョン。 これは、要求パイプラインがメタデータの収集を開始する前に例外がスローされたときに null されます (パラメーターやビルダーの検証など)。 null 以外の場合 (一般的な要求内エラー)、 DurationTotalInMs は常に設定されます (待機時間の測定に役立ちます)。一方、対応するステージが実行されなかった場合、他のフィールドは 0/null になる可能性があります。 障害が発生した場合、 TokenSource には意味のある値がないため、依存しないでください。 成功パスで AuthenticationResultMetadata によって返される型を再利用します。

(継承元 MsalException)
CorrelationId

1 つの認証フローを分割するために使用できる ID。

(継承元 MsalException)
ErrorCode

サービスによって返されるか、クライアントによって生成されたプロトコル エラー コードを取得します。 これは、例外処理に依存できるコードです。 このコードの値は、通常、軽減策の説明を含む派生例外型の定数文字列で提供されます。

(継承元 MsalException)
IsRetryable

この例外が発生した前の操作を再試行する必要があるかどうかを示します。

(継承元 MsalException)

メソッド

Name 説明
ToJsonString()

例外のほとんどの値を JSON にシリアル化できます。

(継承元 MsalException)
ToString()

現在の例外の文字列形式を作成して返します。

(継承元 MsalException)

適用対象