UserFacingError Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401

Assembly:

Az.DataProtection.private.dll

Error object used by layers that have access to localized content, and propagate that to user

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401.UserFacingErrorTypeConverter))]
public class UserFacingError : Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401.IUserFacingError

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401.UserFacingErrorTypeConverter))>]
type UserFacingError = class
    interface IUserFacingError
    interface IJsonSerializable

Public Class UserFacingError
Implements IUserFacingError

Inheritance

Object

UserFacingError

Attributes

TypeConverterAttribute

Implements

IUserFacingError IJsonSerializable

Constructors

UserFacingError()

Creates an new UserFacingError instance.

Properties

Code	Unique code for this error
Detail	Additional related Errors
InnerError	Inner Error
IsRetryable	Whether the operation will be retryable or not
IsUserError	Whether the operation is due to a user error or service error
Message
Property	Any key value pairs that can be injected inside error object
RecommendedAction	RecommendedAction � localized.
Target	Target of the error.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of UserFacingError.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of UserFacingError.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20240401.IUserFacingError.
FromJsonString(String)	Creates a new instance of UserFacingError, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of UserFacingError into a JsonNode.
ToJsonString()	Serializes this instance to a json string.