EntityProperties Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Properties which are common across all kinds of entities
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.EntityPropertiesTypeConverter))]
public class EntityProperties : Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.IEntityProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.EntityPropertiesTypeConverter))>]
type EntityProperties = class
interface IEntityProperties
interface IJsonSerializable
Public Class EntityProperties
Implements IEntityProperties
- Inheritance
-
EntityProperties
- Attributes
- Implements
Constructors
| Name | Description |
|---|---|
| EntityProperties() |
Creates an new EntityProperties instance. |
Properties
| Name | Description |
|---|---|
| CanvaPositionX |
X Coordinate |
| CanvaPositionY |
Y Coordinate |
| DegradedActionGroupId |
Optional list of action group resource IDs to be notified when the alert is triggered. |
| DegradedDescription |
The alert rule description. |
| DegradedSeverity |
The severity of triggered alert. |
| 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 |
| IconCustomData |
Custom data. Base64-encoded SVG data. If set, this overrides the built-in icon. |
| IconName |
Name of the built-in icon, or 'Custom' to use customData |
| Impact |
Impact of the entity in health state propagation |
| ProvisioningState |
The status of the last operation. |
| SignalAggregationGroup |
Logical aggregation groups over the signals on this entity. Overlap is allowed: the same signal may appear in more than one group's members. Each group is evaluated independently according to its strategy, and a shared signal can contribute to multiple group states and related per-group telemetry. Group states contribute alongside any ungrouped signals and the dependency-aggregated child health to the entity's overall worst-of composite. |
| SignalGroup |
Signal groups which are assigned to this entity |
| Tag |
Optional set of tags (key-value pairs) |
| UnhealthyActionGroupId |
Optional list of action group resource IDs to be notified when the alert is triggered. |
| UnhealthyDescription |
The alert rule description. |
| UnhealthySeverity |
The severity of triggered alert. |
Methods
| Name | Description |
|---|---|
| DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of EntityProperties. |
| DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of EntityProperties. |
| FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.IEntityProperties. |
| FromJsonString(String) |
Creates a new instance of EntityProperties, deserializing the content from a json string. |
| ToJson(JsonObject, SerializationMode) |
Serializes this instance of EntityProperties into a JsonNode. |
| ToJsonString() |
Serializes this instance to a json string. |
| ToString() | |