azure.mgmt.alertsmanagement.models module¶
-
class
azure.mgmt.alertsmanagement.models.
OperationDisplay
(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties of the operation.
Parameters: - provider (str) – Provider name
- resource (str) – Resource name
- operation (str) – Operation name
- description (str) – Description of the operation
-
class
azure.mgmt.alertsmanagement.models.
Operation
(*, name: str = None, display=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Operation provided by provider.
Parameters: - name (str) – Name of the operation
- display (OperationDisplay) – Properties of the operation
-
class
azure.mgmt.alertsmanagement.models.
Resource
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
An azure resource object.
Variables are only populated by the server, and will be ignored when sending a request.
Variables:
-
class
azure.mgmt.alertsmanagement.models.
Essentials
(*, target_resource: str = None, target_resource_name: str = None, target_resource_group: str = None, target_resource_type: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
This object contains normalized fields across different monitor service and also contains state related fields.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - severity (str or Severity) – Severity of alert Sev0 being highest and Sev3 being lowest. Possible values include: ‘Sev0’, ‘Sev1’, ‘Sev2’, ‘Sev3’, ‘Sev4’
- signal_type (str or SignalType) – Log based alert or metric based alert. Possible values include: ‘Metric’, ‘Log’, ‘Unknown’
- alert_state (str or AlertState) – Alert object state, which is modified by the user. Possible values include: ‘New’, ‘Acknowledged’, ‘Closed’
- monitor_condition (str or MonitorCondition) – Represents rule condition(Fired/Resolved) maintained by monitor service depending on the state of the state. 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 of the rule condition is not 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.
Parameters: - target_resource (str) – Target ARM resource, on which alert got created.
- target_resource_name (str) – Name of the target ARM resource name, on which alert got created.
- target_resource_group (str) – Resource group of target ARM resource, on which alert got created.
- target_resource_type (str) – Resource type of target ARM resource, on which alert got created.
-
class
azure.mgmt.alertsmanagement.models.
AlertProperties
(*, essentials=None, context=None, egress_config=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Alert property bag.
Parameters: - essentials (Essentials) –
- context (object) –
- egress_config (object) –
-
class
azure.mgmt.alertsmanagement.models.
Alert
(*, properties=None, **kwargs)[source]¶ Bases:
azure.mgmt.alertsmanagement.models.resource_py3.Resource
An alert created in alert management service.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: properties (AlertProperties) –
-
class
azure.mgmt.alertsmanagement.models.
AlertModificationItem
(*, modification_event=None, old_value: str = None, new_value: str = None, modified_at: str = None, modified_by: str = None, comments: str = None, description: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Alert modification item.
Parameters: - modification_event (str or AlertModificationEvent) – Reason for the modification. Possible values include: ‘AlertCreated’, ‘StateChange’, ‘MonitorConditionChange’
- old_value (str) – Old value
- new_value (str) – New value
- modified_at (str) – Modified date and time
- modified_by (str) – Modified user details (Principal client name)
- comments (str) – Modification comments
- description (str) – Description of the modification
-
class
azure.mgmt.alertsmanagement.models.
AlertModificationProperties
(*, modifications=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties of the alert modification item.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: alert_id (str) – Unique Id of the alert for which the history is being retrieved Parameters: modifications (list[AlertModificationItem]) – Modification details
-
class
azure.mgmt.alertsmanagement.models.
AlertModification
(*, properties=None, **kwargs)[source]¶ Bases:
azure.mgmt.alertsmanagement.models.resource_py3.Resource
Alert Modification details.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: properties (AlertModificationProperties) –
-
class
azure.mgmt.alertsmanagement.models.
SmartGroupModificationItem
(*, modification_event=None, old_value: str = None, new_value: str = None, modified_at: str = None, modified_by: str = None, comments: str = None, description: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
smartGroup modification item.
Parameters: - modification_event (str or SmartGroupModificationEvent) – Reason for the modification. Possible values include: ‘SmartGroupCreated’, ‘StateChange’, ‘AlertAdded’, ‘AlertRemoved’
- old_value (str) – Old value
- new_value (str) – New value
- modified_at (str) – Modified date and time
- modified_by (str) – Modified user details (Principal client name)
- comments (str) – Modification comments
- description (str) – Description of the modification
-
class
azure.mgmt.alertsmanagement.models.
SmartGroupModificationProperties
(*, modifications=None, next_link: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties of the smartGroup modification item.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: smart_group_id (str) – Unique Id of the smartGroup for which the history is being retrieved
Parameters: - modifications (list[SmartGroupModificationItem]) – Modification details
- next_link (str) – URL to fetch the next set of results.
-
class
azure.mgmt.alertsmanagement.models.
SmartGroupModification
(*, properties=None, **kwargs)[source]¶ Bases:
azure.mgmt.alertsmanagement.models.resource_py3.Resource
Alert Modification details.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: properties (SmartGroupModificationProperties) –
-
class
azure.mgmt.alertsmanagement.models.
AlertsSummaryGroupItem
(*, name: str = None, count: int = None, groupedby: str = None, values=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Alerts summary group item.
Parameters: - name (str) – Value of the aggregated field
- count (int) – Count of the aggregated field
- groupedby (str) – Name of the field aggregated
- values (list[AlertsSummaryGroupItem]) – List of the items
-
class
azure.mgmt.alertsmanagement.models.
AlertsSummaryGroup
(*, total: int = None, smart_groups_count: int = None, groupedby: str = None, values=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Group the result set.
Parameters: - total (int) – Total count of the result set.
- smart_groups_count (int) – Total count of the smart groups.
- groupedby (str) – Name of the field aggregated
- values (list[AlertsSummaryGroupItem]) – List of the items
-
class
azure.mgmt.alertsmanagement.models.
AlertsSummary
(*, properties=None, **kwargs)[source]¶ Bases:
azure.mgmt.alertsmanagement.models.resource_py3.Resource
Summary of alerts based on the input filters and ‘groupby’ parameters.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: properties (AlertsSummaryGroup) –
-
class
azure.mgmt.alertsmanagement.models.
SmartGroupAggregatedProperty
(*, name: str = None, count: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Aggregated property of each type.
Parameters: - name (str) – Name of the type.
- count (int) – Total number of items of type.
-
class
azure.mgmt.alertsmanagement.models.
SmartGroup
(*, alerts_count: int = None, resources=None, resource_types=None, resource_groups=None, monitor_services=None, monitor_conditions=None, alert_states=None, alert_severities=None, next_link: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.alertsmanagement.models.resource_py3.Resource
Set of related alerts grouped together smartly by AMS.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Azure resource Id
- type (str) – Azure resource type
- name (str) – Azure resource name
- smart_group_state (str or State) – Smart group state. Possible values include: ‘New’, ‘Acknowledged’, ‘Closed’
- severity (str or Severity) – Severity of smart group is the highest(Sev0 >… > Sev4) severity of all the alerts in the group. Possible values include: ‘Sev0’, ‘Sev1’, ‘Sev2’, ‘Sev3’, ‘Sev4’
- start_date_time (datetime) – Creation time of smart group. Date-Time in ISO-8601 format.
- last_modified_date_time (datetime) – Last updated time of smart group. Date-Time in ISO-8601 format.
- last_modified_user_name (str) – Last modified by user name.
Parameters: - alerts_count (int) – Total number of alerts in smart group
- resources (list[SmartGroupAggregatedProperty]) – Summary of target resources in the smart group
- resource_types (list[SmartGroupAggregatedProperty]) – Summary of target resource types in the smart group
- resource_groups (list[SmartGroupAggregatedProperty]) – Summary of target resource groups in the smart group
- monitor_services (list[SmartGroupAggregatedProperty]) – Summary of monitorServices in the smart group
- monitor_conditions (list[SmartGroupAggregatedProperty]) – Summary of monitorConditions in the smart group
- alert_states (list[SmartGroupAggregatedProperty]) – Summary of alertStates in the smart group
- alert_severities (list[SmartGroupAggregatedProperty]) – Summary of alertSeverities in the smart group
- next_link (str) – The URI to fetch the next page of alerts. Call ListNext() with this URI to fetch the next page alerts.
-
class
azure.mgmt.alertsmanagement.models.
SmartGroupsList
(*, next_link: str = None, value=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List the alerts.
Parameters: - next_link (str) – URL to fetch the next set of alerts.
- value (list[SmartGroup]) – List of alerts
-
class
azure.mgmt.alertsmanagement.models.
OperationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Operation
object
-
class
azure.mgmt.alertsmanagement.models.
AlertPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Alert
object
-
class
azure.mgmt.alertsmanagement.models.
Severity
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
sev0
= 'Sev0'¶
-
sev1
= 'Sev1'¶
-
sev2
= 'Sev2'¶
-
sev3
= 'Sev3'¶
-
sev4
= 'Sev4'¶
-
-
class
azure.mgmt.alertsmanagement.models.
SignalType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
log
= 'Log'¶
-
metric
= 'Metric'¶
-
unknown
= 'Unknown'¶
-
-
class
azure.mgmt.alertsmanagement.models.
AlertState
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
acknowledged
= 'Acknowledged'¶
-
closed
= 'Closed'¶
-
new
= 'New'¶
-
-
class
azure.mgmt.alertsmanagement.models.
MonitorCondition
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
fired
= 'Fired'¶
-
resolved
= 'Resolved'¶
-
-
class
azure.mgmt.alertsmanagement.models.
MonitorService
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
activity_log_administrative
= 'ActivityLog Administrative'¶
-
activity_log_autoscale
= 'ActivityLog Autoscale'¶
-
activity_log_policy
= 'ActivityLog Policy'¶
-
activity_log_recommendation
= 'ActivityLog Recommendation'¶
-
activity_log_security
= 'ActivityLog Security'¶
-
application_insights
= 'Application Insights'¶
-
log_analytics
= 'Log Analytics'¶
-
nagios
= 'Nagios'¶
-
platform
= 'Platform'¶
-
scom
= 'SCOM'¶
-
service_health
= 'ServiceHealth'¶
-
smart_detector
= 'SmartDetector'¶
-
vm_insights
= 'VM Insights'¶
-
zabbix
= 'Zabbix'¶
-
-
class
azure.mgmt.alertsmanagement.models.
AlertModificationEvent
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
alert_created
= 'AlertCreated'¶
-
monitor_condition_change
= 'MonitorConditionChange'¶
-
state_change
= 'StateChange'¶
-
-
class
azure.mgmt.alertsmanagement.models.
SmartGroupModificationEvent
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
alert_added
= 'AlertAdded'¶
-
alert_removed
= 'AlertRemoved'¶
-
smart_group_created
= 'SmartGroupCreated'¶
-
state_change
= 'StateChange'¶
-
-
class
azure.mgmt.alertsmanagement.models.
State
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
acknowledged
= 'Acknowledged'¶
-
closed
= 'Closed'¶
-
new
= 'New'¶
-
-
class
azure.mgmt.alertsmanagement.models.
TimeRange
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
oned
= '1d'¶
-
oneh
= '1h'¶
-
sevend
= '7d'¶
-
three_zerod
= '30d'¶
-
-
class
azure.mgmt.alertsmanagement.models.
AlertsSortByFields
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
alert_state
= 'alertState'¶
-
last_modified_date_time
= 'lastModifiedDateTime'¶
-
monitor_condition
= 'monitorCondition'¶
-
name
= 'name'¶
-
severity
= 'severity'¶
-
start_date_time
= 'startDateTime'¶
-
target_resource
= 'targetResource'¶
-
target_resource_group
= 'targetResourceGroup'¶
-
target_resource_name
= 'targetResourceName'¶
-
target_resource_type
= 'targetResourceType'¶
-