ResourceHealthEventData 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.
Service health event.
public class ResourceHealthEventData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ResourceHealth.ResourceHealthEventData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ResourceHealth.ResourceHealthEventData>
type ResourceHealthEventData = class
inherit ResourceData
interface IJsonModel<ResourceHealthEventData>
interface IPersistableModel<ResourceHealthEventData>
Public Class ResourceHealthEventData
Inherits ResourceData
Implements IJsonModel(Of ResourceHealthEventData), IPersistableModel(Of ResourceHealthEventData)
- Inheritance
- Implements
Properties
| Name | Description |
|---|---|
| AdditionalInformationMessage |
Additional information Message. |
| ArgQuery |
Azure Resource Graph query to fetch the affected resources from their existing Azure Resource Graph locations. |
| Article |
Article of event. |
| BillingId |
Billing identifier information. |
| CurrencyType |
Billing currency type information. Example: USD, CAD. |
| Description |
Contains the communication message for the event, that could include summary, root cause and other details. Use fetchEventDetails endpoint to get description of sensitive events. |
| Duration |
duration in seconds. |
| EventLevel |
Level of event. |
| EventSource |
Source of event. |
| EventSubType |
Sub-type of event. |
| EventTags |
A list of metadata tags associated with the event. Possible values include: -Action Recommended: Action may be required by you to avoid possible disruptions or mitigate risks for your services. It is recommended to evaluate these actions and the potential impact on your services.
|
| EventType |
Type of event. |
| ExternalIncidentId |
The id of the Incident. |
| Faqs |
Frequently asked questions for the service health event. |
| Header |
Header text of event. |
| HirStage |
Stage for HIR Document. |
| Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData) |
| Impact |
List services impacted by the service health event. |
| ImpactMitigationOn |
It provides the Timestamp for when the health impacting event resolved. |
| ImpactStartOn |
It provides the Timestamp for when the health impacting event started. |
| ImpactType |
The type of the impact. |
| IsChatWithUsEnabled |
Tells if we want to enable or disable Microsoft Support for this event. |
| IsEventSensitive |
If true the event may contains sensitive data. Use the post events/{trackingId}/fetchEventDetails endpoint to fetch sensitive data see https://learn.microsoft.com/en-us/azure/service-health/security-advisories-elevated-access. |
| IsHirEvent |
It provides information if the event is High incident rate event or not. |
| IsMicrosoftSupportEnabled |
Tells if we want to enable or disable Microsoft Support for this event. |
| IsPlatformInitiated |
Is true if the event is platform initiated. |
| LastUpdateOn |
It provides the Timestamp for when the health impacting event was last updated. |
| Level |
Level of insight. |
| Links |
Useful links of event. |
| MaintenanceId |
Unique identifier for planned maintenance event. |
| MaintenanceType |
The type of planned maintenance event. |
| Name |
The name of the resource. (Inherited from ResourceData) |
| NewRate |
Billing rate change information - new rate. |
| OldRate |
Billing rate change information - old rate. |
| Priority |
Priority level of the event. Has value from 0 to 23. 0 is the highest priority. Service issue events have higher priority followed by planned maintenance and health advisory. Critical events have higher priority followed by error, warning and informational. Furthermore, active events have higher priority than resolved. |
| Reason |
The reason for the Incident. |
| RecommendedActions |
Recommended actions of event. |
| ResourceType |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData) |
| Status |
Current status of event. |
| Summary |
Summary text of event. Use fetchEventDetails endpoint to get summary of sensitive events. |
| SystemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData) |
| Title |
Title text of event. |
Methods
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<ResourceHealthEventData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<ResourceHealthEventData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ResourceHealthEventData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ResourceHealthEventData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ResourceHealthEventData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |