Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HealthErrorSummary

Package version

interface

An interface representing HealthErrorSummary. class to define the summary of the health error details.

Hierarchy

  • HealthErrorSummary

Index

Properties

Optional affectedResourceCorrelationIds

affectedResourceCorrelationIds: string[]
member

{string[]} [affectedResourceCorrelationIds] 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.

Optional affectedResourceSubtype

affectedResourceSubtype: undefined | string
member

{string} [affectedResourceSubtype] The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable.

Optional affectedResourceType

affectedResourceType: undefined | string
member

{string} [affectedResourceType] The type of affected ARM resource.

Optional category

member

{HealthErrorCategory} [category] The category of the health error. Possible values include: 'None', 'Replication', 'TestFailover', 'Configuration', 'FabricInfrastructure', 'VersionExpiry', 'AgentAutoUpdate'

Optional severity

severity: Severity
member

{Severity} [severity] Severity of error. Possible values include: 'NONE', 'Warning', 'Error', 'Info'

Optional summaryCode

summaryCode: undefined | string
member

{string} [summaryCode] The code of the health error.

Optional summaryMessage

summaryMessage: undefined | string
member

{string} [summaryMessage] The summary message of the health error.

Generated using TypeDoc