EntityProperties interface

Package:

@azure/arm-cloudhealth

Properties which are common across all kinds of entities

Properties

alerts	Alert configuration for this entity
canvasPosition	Positioning of the entity on the model canvas
discoveredBy	Discovered by which discovery rule. If set, the entity cannot be deleted manually.
displayName	Display name
healthObjective	Health objective as a percentage of time the entity should be healthy.
healthState	Health state of this entity
icon	Visual icon definition. If not set, a default icon is used.
impact	Impact of the entity in health state propagation
provisioningState	The status of the last operation.
signalGroups	Signal groups which are assigned to this entity
tags	Optional set of tags (key-value pairs)

Property Details

alerts

Alert configuration for this entity

alerts?: EntityAlerts

Property Value

EntityAlerts

canvasPosition

Positioning of the entity on the model canvas

canvasPosition?: EntityCoordinates

Property Value

EntityCoordinates

discoveredBy

Discovered by which discovery rule. If set, the entity cannot be deleted manually.

discoveredBy?: string

Property Value

string

displayName

Display name

displayName?: string

Property Value

string

healthObjective

Health objective as a percentage of time the entity should be healthy.

healthObjective?: number

Property Value

number

healthState

Health state of this entity

healthState?: string

Property Value

string

icon

Visual icon definition. If not set, a default icon is used.

icon?: IconDefinition

Property Value

IconDefinition

impact

Impact of the entity in health state propagation

impact?: string

Property Value

string

provisioningState

The status of the last operation.

provisioningState?: string

Property Value

string

signalGroups

Signal groups which are assigned to this entity

signalGroups?: SignalGroups

Property Value

SignalGroups

tags

Optional set of tags (key-value pairs)

tags?: Record<string, string>

Property Value

Record<string, string>