Language

MsalServiceException クラス

定義

サービスがエラー応答またはその他のネットワーク エラーを返したときにスローされる例外の種類。 詳細については、https://aka.ms/msal-net-exceptions をご覧ください

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

コンストラクター

Name 説明
MsalServiceException(String, String, Exception)

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

MsalServiceException(String, String, Int32, Exception)

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

MsalServiceException(String, String, Int32, String, Exception)

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

MsalServiceException(String, String, Int32)

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

MsalServiceException(String, 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)
Claims

サービスによって要求された追加の要求。 このプロパティが null または空でない場合、これは、サービスがユーザーに 2 要素認証などの追加の要求を提供することを要求することを意味します。 次の 2 つのケースがあります。

詳細については、以下を参照してください。 https://aka.ms/msal-net-claim-challenge
CorrelationId

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

(継承元 MsalException)
ErrorCode

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

(継承元 MsalException)
ErrorCodesForLogging

トークン サービスによって返される STS 固有のエラー コード (50076、50079 などの数値AADSTS コードなど) の一覧ErrorCode。 値はサービスによって出力され、予告なしに変更される可能性があります。診断とログ記録を目的としています。この値に対する運用動作を分岐しないでください。 サービスがエラー コードを指定しなかった場合に null を返します。

Headers

エラーを示したサーバー応答からの HTTP ヘッダーが含まれています。

IsRetryable

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

(継承元 MsalException)
ResponseBody

サーバーから受信した未加工の応答本文。

StatusCode

HTTP レイヤーから返される状態コードを取得します。 この状態コードは、内部HttpStatusCode応答のHttpRequestExceptionか、ブラウザー ベースのフローの NavigateError イベント状態コードです (NavigateError イベント状態コードを参照)。 このコードは、再試行ロジックの実装やエラー調査などの目的で使用できます。

SubErrorForLogging

トークン サービスによる ErrorCode の絞り込みによって返されるサブエラー ( consent_required、 bad_token、 protection_policy_requiredなど)。 値はサービスによって出力され、予告なしに変更される可能性があります。診断とログ記録を目的としています。この値に対する運用動作を分岐しないでください。

メソッド

Name 説明
ToJsonString()

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

(継承元 MsalException)
ToString()

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

UpdateIsRetryable()

エボ、AADとの議論に従って

適用対象