MsalManagedIdentityException Class

Reference

Definition

Namespace:: Microsoft.Identity.Client

Assembly:: Microsoft.Identity.Client.dll

Package:: Microsoft.Identity.Client v4.60.3

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

MsalManagedIdentityException is deprecated and will be removed in a future release. Catch MsalServiceException instead.

This exception class is for exceptions generated from Managed Identity sources. This class is deprecated and will be removed in a future release. Catch MsalServiceException instead. For more details, see https://aka.ms/msal-net-managed-identity

[System.Obsolete("MsalManagedIdentityException is deprecated and will be removed in a future release. Catch MsalServiceException instead.", true)]
public class MsalManagedIdentityException : Microsoft.Identity.Client.MsalServiceException

[<System.Obsolete("MsalManagedIdentityException is deprecated and will be removed in a future release. Catch MsalServiceException instead.", true)>]
type MsalManagedIdentityException = class
    inherit MsalServiceException

Public Class MsalManagedIdentityException
Inherits MsalServiceException

Inheritance: Exception

MsalException

MsalServiceException
MsalManagedIdentityException

Attributes: ObsoleteAttribute

Constructors

MsalManagedIdentityException(String, String, Exception, ManagedIdentitySource)	Initializes a new instance of the exception class with a specified error code, error message and managed identity source.
MsalManagedIdentityException(String, String, Exception, ManagedIdentitySource, Int32)	Initializes a new instance of the exception class with a specified error code, error message and managed identity source.
MsalManagedIdentityException(String, String, ManagedIdentitySource)	Initializes a new instance of the exception class with a specified error code, error message and inner exception indicating the root cause.
MsalManagedIdentityException(String, String, ManagedIdentitySource, Int32)	Initializes a new instance of the exception class with a specified error code, error message and inner exception indicating the root cause.

Fields

BrokerErrorCode	An AdditionalExceptionData property key, available when using desktop brokers. (Inherited from MsalException)
BrokerErrorContext	An AdditionalExceptionData property key, available when using desktop brokers. (Inherited from MsalException)
BrokerErrorStatus	An AdditionalExceptionData property key, available when using desktop brokers. (Inherited from MsalException)
BrokerErrorTag	An AdditionalExceptionData property key, available when using desktop brokers. (Inherited from MsalException)
BrokerTelemetry	An AdditionalExceptionData property key, available when using desktop brokers. (Inherited from MsalException)

Properties

AdditionalExceptionData	A property bag with extra details for this exception. (Inherited from MsalException)
Claims	Additional claims requested by the service. When this property is not null or empty, this means that the service requires the user to provide additional claims, such as doing two factor authentication. The are two cases: If your application is a IPublicClientApplication, you should just call AcquireTokenInteractive(IEnumerable<String>) and add the WithClaims(String) modifier. If your application is a IConfidentialClientApplication, (therefore doing the On-Behalf-Of flow), you should throw an HTTP unauthorize exception with a message containing the claims For more details see https://aka.ms/msal-net-claim-challenge (Inherited from MsalServiceException)
CorrelationId	An ID that can used to piece up a single authentication flow. (Inherited from MsalException)
ErrorCode	Gets the protocol error code returned by the service or generated by the client. This is the code you can rely on for exception handling. Values for this code are typically provided in constant strings in the derived exceptions types with explanations of mitigation. (Inherited from MsalException)
Headers	Contains the HTTP headers from the server response that indicated an error. (Inherited from MsalServiceException)
IsRetryable	Indicates if the previous operation that resulted in this exception should be retried. (Inherited from MsalException)
ManagedIdentitySource	Specifies the managed identity source from which the exception initiates.
ResponseBody	Raw response body received from the server. (Inherited from MsalServiceException)
StatusCode	Gets the status code returned from HTTP layer. This status code is either the `HttpStatusCode` in the inner HttpRequestException response or the NavigateError Event Status Code in a browser based flow (see NavigateError Event Status Codes). You can use this code for purposes such as implementing retry logic or error investigation. (Inherited from MsalServiceException)

Methods

ToJsonString()	Allows serialization of most values of the exception into JSON. (Inherited from MsalException)
ToString()	Creates and returns a string representation of the current exception. (Inherited from MsalServiceException)
UpdateIsRetryable()	Retry error codes specific to managed identity

Applies to