HealthErrorModel interface

Health error model.

Properties

affectedResourceCorrelationIds

Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue.

affectedResourceType

Gets or sets the type of affected resource type.

category

Gets or sets the error category. NOTE: This property will not be serialized. It can only be populated by the server.

causes

Gets or sets possible causes of the error. NOTE: This property will not be serialized. It can only be populated by the server.

childErrors

Gets or sets a list of child health errors associated with this error.

code

Gets or sets the error code. NOTE: This property will not be serialized. It can only be populated by the server.

creationTime

Gets or sets the error creation time. NOTE: This property will not be serialized. It can only be populated by the server.

healthCategory

Gets or sets the health category. NOTE: This property will not be serialized. It can only be populated by the server.

isCustomerResolvable

Gets or sets a value indicating whether the error is customer resolvable. NOTE: This property will not be serialized. It can only be populated by the server.

message

Gets or sets the error message. NOTE: This property will not be serialized. It can only be populated by the server.

recommendation

Gets or sets recommended action to resolve the error. NOTE: This property will not be serialized. It can only be populated by the server.

severity

Gets or sets the error severity. NOTE: This property will not be serialized. It can only be populated by the server.

source

Gets or sets the error source. NOTE: This property will not be serialized. It can only be populated by the server.

summary

Gets or sets the error summary. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

affectedResourceCorrelationIds

Gets or sets the list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue.

affectedResourceCorrelationIds?: string[]

Property Value

string[]

affectedResourceType

Gets or sets the type of affected resource type.

affectedResourceType?: string

Property Value

string

category

Gets or sets the error category. NOTE: This property will not be serialized. It can only be populated by the server.

category?: string

Property Value

string

causes

Gets or sets possible causes of the error. NOTE: This property will not be serialized. It can only be populated by the server.

causes?: string

Property Value

string

childErrors

Gets or sets a list of child health errors associated with this error.

childErrors?: InnerHealthErrorModel[]

Property Value

code

Gets or sets the error code. NOTE: This property will not be serialized. It can only be populated by the server.

code?: string

Property Value

string

creationTime

Gets or sets the error creation time. NOTE: This property will not be serialized. It can only be populated by the server.

creationTime?: Date

Property Value

Date

healthCategory

Gets or sets the health category. NOTE: This property will not be serialized. It can only be populated by the server.

healthCategory?: string

Property Value

string

isCustomerResolvable

Gets or sets a value indicating whether the error is customer resolvable. NOTE: This property will not be serialized. It can only be populated by the server.

isCustomerResolvable?: boolean

Property Value

boolean

message

Gets or sets the error message. NOTE: This property will not be serialized. It can only be populated by the server.

message?: string

Property Value

string

recommendation

Gets or sets recommended action to resolve the error. NOTE: This property will not be serialized. It can only be populated by the server.

recommendation?: string

Property Value

string

severity

Gets or sets the error severity. NOTE: This property will not be serialized. It can only be populated by the server.

severity?: string

Property Value

string

source

Gets or sets the error source. NOTE: This property will not be serialized. It can only be populated by the server.

source?: string

Property Value

string

summary

Gets or sets the error summary. NOTE: This property will not be serialized. It can only be populated by the server.

summary?: string

Property Value

string