语言

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
派生

构造函数

名称 说明
MsalServiceException(String, String, Exception)

使用指定的错误代码、错误消息和对此异常原因的内部异常的引用初始化异常类的新实例。

MsalServiceException(String, String, Int32, Exception)

使用指定的错误代码、错误消息和对此异常原因的内部异常的引用初始化异常类的新实例。

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

使用指定的错误代码、错误消息和对此异常原因的内部异常的引用初始化异常类的新实例。

MsalServiceException(String, String, Int32)

使用指定的错误代码、错误消息和对此异常原因的内部异常的引用初始化异常类的新实例。

MsalServiceException(String, String)

使用指定的错误代码、错误消息和对此异常原因的内部异常的引用初始化异常类的新实例。

字段

名称 说明
AuthenticationResultMetadataKey

当令牌获取失败且非MsalException密钥时,MSAL 将AuthenticationResultMetadata捕获的存储到的密钥Data。 即使原始异常未更改,下游使用者也能显示令牌获取诊断。

(继承自 MsalException)
BrokerErrorCode

使用 AdditionalExceptionData 桌面代理时可用的属性键。

(继承自 MsalException)
BrokerErrorContext

使用 AdditionalExceptionData 桌面代理时可用的属性键。

(继承自 MsalException)
BrokerErrorStatus

使用 AdditionalExceptionData 桌面代理时可用的属性键。

(继承自 MsalException)
BrokerErrorTag

使用 AdditionalExceptionData 桌面代理时可用的属性键。

(继承自 MsalException)
BrokerTelemetry

使用 AdditionalExceptionData 桌面代理时可用的属性键。

(继承自 MsalException)
ManagedIdentitySource

使用 AdditionalExceptionData 托管标识时可用的属性密钥。

(继承自 MsalException)

属性

名称 说明
AdditionalExceptionData

具有此异常的额外详细信息的属性包。

(继承自 MsalException)
AuthenticationResultMetadata

失败令牌获取尝试的诊断元数据 - 总持续时间,以及相关阶段运行时、HTTP/缓存持续时间、令牌终结点和区域使用的诊断元数据。 这是 null 在请求管道开始收集元数据(例如参数或生成器验证)之前引发异常的情况。 当非 null(典型的请求内失败 DurationTotalInMs )始终填充(对于延迟度量很有用),而当相应阶段未运行时,其他字段可能为 0/null。 在失败 TokenSource 时没有有意义的价值,不应依赖。 重用成功路径上返回 AuthenticationResultMetadata 的类型。

(继承自 MsalException)
Claims

服务请求的其他声明。 如果此属性不为 null 或为空,则表示服务要求用户提供其他声明,例如执行双重身份验证。 有两种情况:

有关详细信息,请参阅 https://aka.ms/msal-net-claim-challenge
CorrelationId

可用于拼凑单个身份验证流的 ID。

(继承自 MsalException)
ErrorCode

获取服务或客户端生成的协议错误代码。 这是可用于异常处理的代码。 此代码的值通常在派生异常类型的常量字符串中提供,并提供缓解说明。

(继承自 MsalException)
ErrorCodesForLogging

令牌服务返回的特定于 STS 的错误代码列表(例如 AADSTS ,数值代码,例如 50076, 50079)的优化 ErrorCode。 值由服务发出,可以不通知更改;用于诊断和日志记录 - 不要对此值进行生产行为分支。 当服务未提供错误代码时返回 null 。

Headers

包含服务器响应中指示错误的 HTTP 标头。

IsRetryable

指示是否应重试导致此异常的上一个操作。

(继承自 MsalException)
ResponseBody

从服务器接收的原始响应正文。

StatusCode

获取从 HTTP 层返回的状态代码。 此状态代码是 HttpStatusCode 内部响应中的 HttpRequestException 代码,或者是基于浏览器的流中的 NavigateError 事件状态代码(请参阅 NavigateError 事件状态代码)。 可以使用此代码来实现重试逻辑或错误调查等目的。

SubErrorForLogging

令牌服务优化ErrorCode返回的子错误(例如consent_required,bad_tokenprotection_policy_required)。 值由服务发出,可以不通知更改;用于诊断和日志记录 - 不要对此值进行生产行为分支。

方法

名称 说明
ToJsonString()

允许将异常的大多数值序列化为 JSON。

(继承自 MsalException)
ToString()

创建并返回当前异常的字符串表示形式。

UpdateIsRetryable()

根据与 Evo 的讨论,AAD

适用于