Essentials Class

This object contains consistent fields across different monitor services.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

Model

Essentials

Constructor

Essentials(*, target_resource: Optional[str] = None, target_resource_name: Optional[str] = None, target_resource_group: Optional[str] = None, target_resource_type: Optional[str] = None, **kwargs)

Parameters

target_resource

str

Required

Target ARM resource, on which alert got created.

target_resource_name

str

Required

Name of the target ARM resource name, on which alert got created.

target_resource_group

str

Required

Resource group of target ARM resource, on which alert got created.

target_resource_type

str

Required

Resource type of target ARM resource, on which alert got created.

Variables

severity

str or Severity

Severity of alert Sev0 being highest and Sev4 being lowest. Possible values include: "Sev0", "Sev1", "Sev2", "Sev3", "Sev4".

signal_type

str or SignalType

The type of signal the alert is based on, which could be metrics, logs or activity logs. Possible values include: "Metric", "Log", "Unknown".

alert_state

str or AlertState

Alert object state, which can be modified by the user. Possible values include: "New", "Acknowledged", "Closed".

monitor_condition

str or MonitorCondition

Condition of the rule at the monitor service. It represents whether the underlying conditions have crossed the defined alert rule thresholds. Possible values include: "Fired", "Resolved".

monitor_service

str or MonitorService

Monitor service on which the rule(monitor) is set. Possible values include: "Application Insights", "ActivityLog Administrative", "ActivityLog Security", "ActivityLog Recommendation", "ActivityLog Policy", "ActivityLog Autoscale", "Log Analytics", "Nagios", "Platform", "SCOM", "ServiceHealth", "SmartDetector", "VM Insights", "Zabbix".

alert_rule

str

Rule(monitor) which fired alert instance. Depending on the monitor service, this would be ARM id or name of the rule.

source_created_id

str

Unique Id created by monitor service for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc.

smart_group_id

str

Unique Id of the smart group.

smart_grouping_reason

str

Verbose reason describing the reason why this alert instance is added to a smart group.

start_date_time

datetime

Creation time(ISO-8601 format) of alert instance.

last_modified_date_time

datetime

Last modification time(ISO-8601 format) of alert instance.

monitor_condition_resolved_date_time

datetime

Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met.

last_modified_user_name

str

User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user.