UserFacingError interface

  • Reference
Package:
@azure/arm-dataprotection

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

Properties

code

Unique code for this error
details

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
properties

Any key value pairs that can be injected inside error object
recommendedAction

RecommendedAction � localized.
target

Target of the error.

Property Details

code

Unique code for this error

code?: string

Property Value

string

details

Additional related Errors

details?: UserFacingError[]

Property Value

UserFacingError[]

innerError

Inner Error

innerError?: InnerError

Property Value

InnerError

isRetryable

Whether the operation will be retryable or not

isRetryable?: boolean

Property Value

boolean

isUserError

Whether the operation is due to a user error or service error

isUserError?: boolean

Property Value

boolean

message 

message?: string

Property Value

string

properties

Any key value pairs that can be injected inside error object

properties?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

recommendedAction

RecommendedAction � localized.

recommendedAction?: string[]

Property Value

string[]

target

Target of the error.

target?: string

Property Value

string