Entity Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models

Assembly:

Az.CloudHealth.private.dll

An entity (aka node) of a health model

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.EntityTypeConverter))]
public class Entity : Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.IEntity, Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.EntityTypeConverter))>]
type Entity = class
    interface IEntity
    interface IJsonSerializable
    interface IProxyResource
    interface IResource
    interface IValidates

Public Class Entity
Implements IEntity, IValidates

Inheritance

Object

Entity

Attributes

TypeConverterAttribute

Implements

IEntity IProxyResource IResource IJsonSerializable IValidates

Constructors

Name	Description
Entity()	Creates an new Entity 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
Id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Impact	Impact of the entity in health state propagation
Name	The name of the resource
ProvisioningState	The status of the last operation.
ResourceGroupName	Gets the resource group name
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
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC)
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Tag	Optional set of tags (key-value pairs)
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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 Entity.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of Entity.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.IEntity.
FromJsonString(String)	Creates a new instance of Entity, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of Entity into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.