IEntity Interface
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.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.EntityTypeConverter))]
public interface IEntity : Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.IProxyResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CloudHealth.Models.EntityTypeConverter))>]
type IEntity = interface
interface IJsonSerializable
interface IProxyResource
interface IResource
Public Interface IEntity
Implements IProxyResource
- Derived
- Attributes
- Implements
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} (Inherited from IResource) |
| Impact |
Impact of the entity in health state propagation |
| Name |
The name of the resource (Inherited from IResource) |
| 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 |
| SystemDataCreatedAt |
The timestamp of resource creation (UTC). (Inherited from IResource) |
| SystemDataCreatedBy |
The identity that created the resource. (Inherited from IResource) |
| SystemDataCreatedByType |
The type of identity that created the resource. (Inherited from IResource) |
| SystemDataLastModifiedAt |
The timestamp of resource last modification (UTC) (Inherited from IResource) |
| SystemDataLastModifiedBy |
The identity that last modified the resource. (Inherited from IResource) |
| SystemDataLastModifiedByType |
The type of identity that last modified the resource. (Inherited from IResource) |
| Tag |
Optional set of tags (key-value pairs) |
| Type |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" (Inherited from IResource) |
| 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 |
|---|---|
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |