azure.mgmt.alertsmanagement.models module

class azure.mgmt.alertsmanagement.models.Action(**kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Action to be applied.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AddActionGroups, RemoveAllActionGroups

All required parameters must be populated in order to send to Azure.

Variables

action_type (str or ActionType) – Action that should be applied. Required. Known values are: “AddActionGroups” and “RemoveAllActionGroups”.

class azure.mgmt.alertsmanagement.models.ActionStatus(*, is_suppressed: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Action status.

Variables

is_suppressed (bool) – Value indicating whether alert is suppressed.

Keyword Arguments

is_suppressed (bool) – Value indicating whether alert is suppressed.

class azure.mgmt.alertsmanagement.models.ActionType(value)[source]

Bases: str, enum.Enum

Action that should be applied.

ADD_ACTION_GROUPS = 'AddActionGroups'
REMOVE_ALL_ACTION_GROUPS = 'RemoveAllActionGroups'
class azure.mgmt.alertsmanagement.models.AddActionGroups(*, action_group_ids: List[str], **kwargs)[source]

Bases: azure.mgmt.alertsmanagement.models._models_py3.Action

Add action groups to alert processing rule.

All required parameters must be populated in order to send to Azure.

Variables

  • action_type (str or ActionType) – Action that should be applied. Required. Known values are: “AddActionGroups” and “RemoveAllActionGroups”.

  • action_group_ids (list[str]) – List of action group Ids to add to alert processing rule. Required.

Keyword Arguments

action_group_ids (list[str]) – List of action group Ids to add to alert processing rule. Required.

class azure.mgmt.alertsmanagement.models.Alert(*, properties: Optional[_models.AlertProperties] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement.models._models_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

  • id (str) – Azure resource Id.

  • type (str) – Azure resource type.

  • name (str) – Azure resource name.

  • properties (AlertProperties) – Alert property bag.

Keyword Arguments

properties (AlertProperties) – Alert property bag.

class azure.mgmt.alertsmanagement.models.AlertModification(*, properties: Optional[_models.AlertModificationProperties] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement.models._models_py3.Resource

Alert Modification details.

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

Variables
Keyword Arguments

properties (AlertModificationProperties) – Properties of the alert modification item.

class azure.mgmt.alertsmanagement.models.AlertModificationEvent(value)[source]

Bases: str, enum.Enum

Reason for the modification.

ACTIONS_FAILED = 'ActionsFailed'
ACTIONS_SUPPRESSED = 'ActionsSuppressed'
ACTIONS_TRIGGERED = 'ActionsTriggered'
ACTION_RULE_SUPPRESSED = 'ActionRuleSuppressed'
ACTION_RULE_TRIGGERED = 'ActionRuleTriggered'
ALERT_CREATED = 'AlertCreated'
MONITOR_CONDITION_CHANGE = 'MonitorConditionChange'
SEVERITY_CHANGE = 'SeverityChange'
STATE_CHANGE = 'StateChange'
class azure.mgmt.alertsmanagement.models.AlertModificationItem(*, modification_event: Optional[Union[str, _models.AlertModificationEvent]] = None, old_value: Optional[str] = None, new_value: Optional[str] = None, modified_at: Optional[str] = None, modified_by: Optional[str] = None, comments: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Alert modification item.

Variables

  • modification_event (str or AlertModificationEvent) – Reason for the modification. Known values are: “AlertCreated”, “StateChange”, “MonitorConditionChange”, “SeverityChange”, “ActionRuleTriggered”, “ActionRuleSuppressed”, “ActionsTriggered”, “ActionsSuppressed”, and “ActionsFailed”.

  • 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.

Keyword Arguments

  • modification_event (str or AlertModificationEvent) – Reason for the modification. Known values are: “AlertCreated”, “StateChange”, “MonitorConditionChange”, “SeverityChange”, “ActionRuleTriggered”, “ActionRuleSuppressed”, “ActionsTriggered”, “ActionsSuppressed”, and “ActionsFailed”.

  • 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: Optional[List[_models.AlertModificationItem]] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._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.

  • modifications (list[AlertModificationItem]) – Modification details.

Keyword Arguments

modifications (list[AlertModificationItem]) – Modification details.

class azure.mgmt.alertsmanagement.models.AlertProcessingRule(*, location: str, tags: Optional[Dict[str, str]] = None, properties: Optional[_models.AlertProcessingRuleProperties] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement.models._models_py3.ManagedResource

Alert processing rule object containing target scopes, conditions and scheduling logic.

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

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Azure resource Id.

  • type (str) – Azure resource type.

  • name (str) – Azure resource name.

  • location (str) – Resource location. Required.

  • tags (dict[str, str]) – Resource tags.

  • properties (AlertProcessingRuleProperties) – Alert processing rule properties.

  • system_data (SystemData) – Alert processing rule system data.

Keyword Arguments
class azure.mgmt.alertsmanagement.models.AlertProcessingRuleProperties(*, scopes: List[str], actions: List[_models.Action], conditions: Optional[List[_models.Condition]] = None, schedule: Optional[_models.Schedule] = None, description: Optional[str] = None, enabled: bool = True, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Alert processing rule properties defining scopes, conditions and scheduling logic for alert processing rule.

All required parameters must be populated in order to send to Azure.

Variables

  • scopes (list[str]) – Scopes on which alert processing rule will apply. Required.

  • conditions (list[Condition]) – Conditions on which alerts will be filtered.

  • schedule (Schedule) – Scheduling for alert processing rule.

  • actions (list[Action]) – Actions to be applied. Required.

  • description (str) – Description of alert processing rule.

  • enabled (bool) – Indicates if the given alert processing rule is enabled or disabled.

Keyword Arguments

  • scopes (list[str]) – Scopes on which alert processing rule will apply. Required.

  • conditions (list[Condition]) – Conditions on which alerts will be filtered.

  • schedule (Schedule) – Scheduling for alert processing rule.

  • actions (list[Action]) – Actions to be applied. Required.

  • description (str) – Description of alert processing rule.

  • enabled (bool) – Indicates if the given alert processing rule is enabled or disabled.

class azure.mgmt.alertsmanagement.models.AlertProcessingRulesList(*, next_link: Optional[str] = None, value: Optional[List[_models.AlertProcessingRule]] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

List of alert processing rules.

Variables

  • next_link (str) – URL to fetch the next set of alert processing rules.

  • value (list[AlertProcessingRule]) – List of alert processing rules.

Keyword Arguments

  • next_link (str) – URL to fetch the next set of alert processing rules.

  • value (list[AlertProcessingRule]) – List of alert processing rules.

class azure.mgmt.alertsmanagement.models.AlertProperties(*, essentials: Optional[_models.Essentials] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Alert property bag.

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

Variables

  • essentials (Essentials) – This object contains consistent fields across different monitor services.

  • context (JSON) – Information specific to the monitor service that gives more contextual details about the alert.

  • egress_config (JSON) – Config which would be used for displaying the data in portal.

Keyword Arguments

essentials (Essentials) – This object contains consistent fields across different monitor services.

class azure.mgmt.alertsmanagement.models.AlertState(value)[source]

Bases: str, enum.Enum

AlertState.

ACKNOWLEDGED = 'Acknowledged'
CLOSED = 'Closed'
NEW = 'New'
class azure.mgmt.alertsmanagement.models.AlertsList(*, next_link: Optional[str] = None, value: Optional[List[_models.Alert]] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

List the alerts.

Variables

  • next_link (str) – URL to fetch the next set of alerts.

  • value (list[Alert]) – List of alerts.

Keyword Arguments

  • next_link (str) – URL to fetch the next set of alerts.

  • value (list[Alert]) – List of alerts.

class azure.mgmt.alertsmanagement.models.AlertsMetaData(*, properties: Optional[_models.AlertsMetaDataProperties] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

alert meta data information.

Variables

properties (AlertsMetaDataProperties) – alert meta data property bag.

Keyword Arguments

properties (AlertsMetaDataProperties) – alert meta data property bag.

class azure.mgmt.alertsmanagement.models.AlertsMetaDataProperties(**kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

alert meta data property bag.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MonitorServiceList

All required parameters must be populated in order to send to Azure.

Variables

metadata_identifier (str or MetadataIdentifier) – Identification of the information to be retrieved by API call. Required. “MonitorServiceList”

class azure.mgmt.alertsmanagement.models.AlertsSortByFields(value)[source]

Bases: str, enum.Enum

AlertsSortByFields.

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'
class azure.mgmt.alertsmanagement.models.AlertsSummary(*, properties: Optional[_models.AlertsSummaryGroup] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement.models._models_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
Keyword Arguments

properties (AlertsSummaryGroup) – Group the result set.

class azure.mgmt.alertsmanagement.models.AlertsSummaryGroup(*, total: Optional[int] = None, smart_groups_count: Optional[int] = None, groupedby: Optional[str] = None, values: Optional[List[_models.AlertsSummaryGroupItem]] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Group the result set.

Variables

  • 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.

Keyword Arguments

  • 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.AlertsSummaryGroupByFields(value)[source]

Bases: str, enum.Enum

AlertsSummaryGroupByFields.

ALERT_RULE = 'alertRule'
ALERT_STATE = 'alertState'
MONITOR_CONDITION = 'monitorCondition'
MONITOR_SERVICE = 'monitorService'
SEVERITY = 'severity'
SIGNAL_TYPE = 'signalType'
class azure.mgmt.alertsmanagement.models.AlertsSummaryGroupItem(*, name: Optional[str] = None, count: Optional[int] = None, groupedby: Optional[str] = None, values: Optional[List[_models.AlertsSummaryGroupItem]] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Alerts summary group item.

Variables

  • 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.

Keyword Arguments

  • 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.Condition(*, field: Optional[Union[str, _models.Field]] = None, operator: Optional[Union[str, _models.Operator]] = None, values: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Condition to trigger an alert processing rule.

Variables

  • field (str or Field) – Field for a given condition. Known values are: “Severity”, “MonitorService”, “MonitorCondition”, “SignalType”, “TargetResourceType”, “TargetResource”, “TargetResourceGroup”, “AlertRuleId”, “AlertRuleName”, “Description”, and “AlertContext”.

  • operator (str or Operator) – Operator for a given condition. Known values are: “Equals”, “NotEquals”, “Contains”, and “DoesNotContain”.

  • values (list[str]) – List of values to match for a given condition.

Keyword Arguments

  • field (str or Field) – Field for a given condition. Known values are: “Severity”, “MonitorService”, “MonitorCondition”, “SignalType”, “TargetResourceType”, “TargetResource”, “TargetResourceGroup”, “AlertRuleId”, “AlertRuleName”, “Description”, and “AlertContext”.

  • operator (str or Operator) – Operator for a given condition. Known values are: “Equals”, “NotEquals”, “Contains”, and “DoesNotContain”.

  • values (list[str]) – List of values to match for a given condition.

class azure.mgmt.alertsmanagement.models.CreatedByType(value)[source]

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.alertsmanagement.models.DailyRecurrence(*, start_time: Optional[str] = None, end_time: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement.models._models_py3.Recurrence

Daily recurrence object.

All required parameters must be populated in order to send to Azure.

Variables

  • recurrence_type (str or RecurrenceType) – Specifies when the recurrence should be applied. Required. Known values are: “Daily”, “Weekly”, and “Monthly”.

  • start_time (str) – Start time for recurrence.

  • end_time (str) – End time for recurrence.

Keyword Arguments

  • start_time (str) – Start time for recurrence.

  • end_time (str) – End time for recurrence.

class azure.mgmt.alertsmanagement.models.DaysOfWeek(value)[source]

Bases: str, enum.Enum

Days of week.

FRIDAY = 'Friday'
MONDAY = 'Monday'
SATURDAY = 'Saturday'
SUNDAY = 'Sunday'
THURSDAY = 'Thursday'
TUESDAY = 'Tuesday'
WEDNESDAY = 'Wednesday'
class azure.mgmt.alertsmanagement.models.ErrorResponse(*, error: Optional[_models.ErrorResponseBody] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

An error response from the service.

Variables

error (ErrorResponseBody) – Details of error response.

Keyword Arguments

error (ErrorResponseBody) – Details of error response.

class azure.mgmt.alertsmanagement.models.ErrorResponseAutoGenerated(*, error: Optional[_models.ErrorResponseBodyAutoGenerated] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

An error response from the service.

Variables

error (ErrorResponseBodyAutoGenerated) – Details of error response.

Keyword Arguments

error (ErrorResponseBodyAutoGenerated) – Details of error response.

class azure.mgmt.alertsmanagement.models.ErrorResponseAutoGenerated2(*, error: Optional[_models.ErrorResponseBodyAutoGenerated2] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

An error response from the service.

Variables

error (ErrorResponseBodyAutoGenerated2) – Details of error response.

Keyword Arguments

error (ErrorResponseBodyAutoGenerated2) – Details of error response.

class azure.mgmt.alertsmanagement.models.ErrorResponseBody(*, code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, details: Optional[List[_models.ErrorResponseBody]] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Details of error response.

Variables

  • code (str) – Error code, intended to be consumed programmatically.

  • message (str) – Description of the error, intended for display in user interface.

  • target (str) – Target of the particular error, for example name of the property.

  • details (list[ErrorResponseBody]) – A list of additional details about the error.

Keyword Arguments

  • code (str) – Error code, intended to be consumed programmatically.

  • message (str) – Description of the error, intended for display in user interface.

  • target (str) – Target of the particular error, for example name of the property.

  • details (list[ErrorResponseBody]) – A list of additional details about the error.

class azure.mgmt.alertsmanagement.models.ErrorResponseBodyAutoGenerated(*, code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, details: Optional[List[_models.ErrorResponseBodyAutoGenerated]] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Details of error response.

Variables

  • code (str) – Error code, intended to be consumed programmatically.

  • message (str) – Description of the error, intended for display in user interface.

  • target (str) – Target of the particular error, for example name of the property.

  • details (list[ErrorResponseBodyAutoGenerated]) – A list of additional details about the error.

Keyword Arguments

  • code (str) – Error code, intended to be consumed programmatically.

  • message (str) – Description of the error, intended for display in user interface.

  • target (str) – Target of the particular error, for example name of the property.

  • details (list[ErrorResponseBodyAutoGenerated]) – A list of additional details about the error.

class azure.mgmt.alertsmanagement.models.ErrorResponseBodyAutoGenerated2(*, code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, details: Optional[List[_models.ErrorResponseBodyAutoGenerated2]] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Details of error response.

Variables

  • code (str) – Error code, intended to be consumed programmatically.

  • message (str) – Description of the error, intended for display in user interface.

  • target (str) – Target of the particular error, for example name of the property.

  • details (list[ErrorResponseBodyAutoGenerated2]) – A list of additional details about the error.

Keyword Arguments

  • code (str) – Error code, intended to be consumed programmatically.

  • message (str) – Description of the error, intended for display in user interface.

  • target (str) – Target of the particular error, for example name of the property.

  • details (list[ErrorResponseBodyAutoGenerated2]) – A list of additional details about the error.

class azure.mgmt.alertsmanagement.models.Essentials(*, target_resource: Optional[str] = None, target_resource_name: Optional[str] = None, target_resource_group: Optional[str] = None, target_resource_type: Optional[str] = None, action_status: Optional[_models.ActionStatus] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

This object contains consistent fields across different monitor services.

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 Sev4 being lowest. Known values are: “Sev0”, “Sev1”, “Sev2”, “Sev3”, and “Sev4”.

  • signal_type (str or SignalType) – The type of signal the alert is based on, which could be metrics, logs or activity logs. Known values are: “Metric”, “Log”, and “Unknown”.

  • alert_state (str or AlertState) – Alert object state, which can be modified by the user. Known values are: “New”, “Acknowledged”, and “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. Known values are: “Fired” and “Resolved”.

  • 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.

  • monitor_service (str or MonitorService) – Monitor service on which the rule(monitor) is set. Known values are: “Application Insights”, “ActivityLog Administrative”, “ActivityLog Security”, “ActivityLog Recommendation”, “ActivityLog Policy”, “ActivityLog Autoscale”, “Log Analytics”, “Nagios”, “Platform”, “SCOM”, “ServiceHealth”, “SmartDetector”, “VM Insights”, and “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.

  • action_status (ActionStatus) – Action status.

  • description (str) – Alert description.

Keyword Arguments

  • 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.

  • action_status (ActionStatus) – Action status.

  • description (str) – Alert description.

class azure.mgmt.alertsmanagement.models.Field(value)[source]

Bases: str, enum.Enum

Field for a given condition.

ALERT_CONTEXT = 'AlertContext'
ALERT_RULE_ID = 'AlertRuleId'
ALERT_RULE_NAME = 'AlertRuleName'
DESCRIPTION = 'Description'
MONITOR_CONDITION = 'MonitorCondition'
MONITOR_SERVICE = 'MonitorService'
SEVERITY = 'Severity'
SIGNAL_TYPE = 'SignalType'
TARGET_RESOURCE = 'TargetResource'
TARGET_RESOURCE_GROUP = 'TargetResourceGroup'
TARGET_RESOURCE_TYPE = 'TargetResourceType'
class azure.mgmt.alertsmanagement.models.Identifier(value)[source]

Bases: str, enum.Enum

Identifier.

MONITOR_SERVICE_LIST = 'MonitorServiceList'
class azure.mgmt.alertsmanagement.models.ManagedResource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement.models._models_py3.Resource

An azure managed resource object.

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

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Azure resource Id.

  • type (str) – Azure resource type.

  • name (str) – Azure resource name.

  • location (str) – Resource location. Required.

  • tags (dict[str, str]) – Resource tags.

Keyword Arguments

  • location (str) – Resource location. Required.

  • tags (dict[str, str]) – Resource tags.

class azure.mgmt.alertsmanagement.models.MetadataIdentifier(value)[source]

Bases: str, enum.Enum

Identification of the information to be retrieved by API call.

MONITOR_SERVICE_LIST = 'MonitorServiceList'
class azure.mgmt.alertsmanagement.models.MonitorCondition(value)[source]

Bases: str, enum.Enum

MonitorCondition.

FIRED = 'Fired'
RESOLVED = 'Resolved'
class azure.mgmt.alertsmanagement.models.MonitorService(value)[source]

Bases: str, enum.Enum

MonitorService.

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.MonitorServiceDetails(*, name: Optional[str] = None, display_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Details of a monitor service.

Variables

  • name (str) – Monitor service name.

  • display_name (str) – Monitor service display name.

Keyword Arguments

  • name (str) – Monitor service name.

  • display_name (str) – Monitor service display name.

class azure.mgmt.alertsmanagement.models.MonitorServiceList(*, data: List[_models.MonitorServiceDetails], **kwargs)[source]

Bases: azure.mgmt.alertsmanagement.models._models_py3.AlertsMetaDataProperties

Monitor service details.

All required parameters must be populated in order to send to Azure.

Variables
Keyword Arguments

data (list[MonitorServiceDetails]) – Array of operations. Required.

class azure.mgmt.alertsmanagement.models.MonthlyRecurrence(*, days_of_month: List[int], start_time: Optional[str] = None, end_time: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement.models._models_py3.Recurrence

Monthly recurrence object.

All required parameters must be populated in order to send to Azure.

Variables

  • recurrence_type (str or RecurrenceType) – Specifies when the recurrence should be applied. Required. Known values are: “Daily”, “Weekly”, and “Monthly”.

  • start_time (str) – Start time for recurrence.

  • end_time (str) – End time for recurrence.

  • days_of_month (list[int]) – Specifies the values for monthly recurrence pattern. Required.

Keyword Arguments

  • start_time (str) – Start time for recurrence.

  • end_time (str) – End time for recurrence.

  • days_of_month (list[int]) – Specifies the values for monthly recurrence pattern. Required.

class azure.mgmt.alertsmanagement.models.Operation(*, name: Optional[str] = None, display: Optional[_models.OperationDisplay] = None, origin: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Operation provided by provider.

Variables

  • name (str) – Name of the operation.

  • display (OperationDisplay) – Properties of the operation.

  • origin (str) – Origin of the operation.

Keyword Arguments

  • name (str) – Name of the operation.

  • display (OperationDisplay) – Properties of the operation.

  • origin (str) – Origin of the operation.

class azure.mgmt.alertsmanagement.models.OperationDisplay(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Properties of the operation.

Variables

  • provider (str) – Provider name.

  • resource (str) – Resource name.

  • operation (str) – Operation name.

  • description (str) – Description of the operation.

Keyword Arguments

  • provider (str) – Provider name.

  • resource (str) – Resource name.

  • operation (str) – Operation name.

  • description (str) – Description of the operation.

class azure.mgmt.alertsmanagement.models.OperationsList(*, value: List[_models.Operation], next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Lists the operations available in the AlertsManagement RP.

All required parameters must be populated in order to send to Azure.

Variables

  • next_link (str) – URL to fetch the next set of alerts.

  • value (list[Operation]) – Array of operations. Required.

Keyword Arguments

  • next_link (str) – URL to fetch the next set of alerts.

  • value (list[Operation]) – Array of operations. Required.

class azure.mgmt.alertsmanagement.models.Operator(value)[source]

Bases: str, enum.Enum

Operator for a given condition.

CONTAINS = 'Contains'
DOES_NOT_CONTAIN = 'DoesNotContain'
EQUALS = 'Equals'
NOT_EQUALS = 'NotEquals'
class azure.mgmt.alertsmanagement.models.PatchObject(*, tags: Optional[Dict[str, str]] = None, enabled: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Data contract for patch.

Variables

  • tags (dict[str, str]) – Tags to be updated.

  • enabled (bool) – Indicates if the given alert processing rule is enabled or disabled.

Keyword Arguments

  • tags (dict[str, str]) – Tags to be updated.

  • enabled (bool) – Indicates if the given alert processing rule is enabled or disabled.

class azure.mgmt.alertsmanagement.models.Recurrence(*, start_time: Optional[str] = None, end_time: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Recurrence object.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DailyRecurrence, MonthlyRecurrence, WeeklyRecurrence

All required parameters must be populated in order to send to Azure.

Variables

  • recurrence_type (str or RecurrenceType) – Specifies when the recurrence should be applied. Required. Known values are: “Daily”, “Weekly”, and “Monthly”.

  • start_time (str) – Start time for recurrence.

  • end_time (str) – End time for recurrence.

Keyword Arguments

  • start_time (str) – Start time for recurrence.

  • end_time (str) – End time for recurrence.

class azure.mgmt.alertsmanagement.models.RecurrenceType(value)[source]

Bases: str, enum.Enum

Specifies when the recurrence should be applied.

DAILY = 'Daily'
MONTHLY = 'Monthly'
WEEKLY = 'Weekly'
class azure.mgmt.alertsmanagement.models.RemoveAllActionGroups(**kwargs)[source]

Bases: azure.mgmt.alertsmanagement.models._models_py3.Action

Indicates if all action groups should be removed.

All required parameters must be populated in order to send to Azure.

Variables

action_type (str or ActionType) – Action that should be applied. Required. Known values are: “AddActionGroups” and “RemoveAllActionGroups”.

class azure.mgmt.alertsmanagement.models.Resource(**kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

An azure resource object.

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.

class azure.mgmt.alertsmanagement.models.Schedule(*, effective_from: Optional[str] = None, effective_until: Optional[str] = None, time_zone: Optional[str] = None, recurrences: Optional[List[_models.Recurrence]] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Scheduling configuration for a given alert processing rule.

Variables

  • effective_from (str) – Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix.

  • effective_until (str) – Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix.

  • time_zone (str) – Scheduling time zone.

  • recurrences (list[Recurrence]) – List of recurrences.

Keyword Arguments

  • effective_from (str) – Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix.

  • effective_until (str) – Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix.

  • time_zone (str) – Scheduling time zone.

  • recurrences (list[Recurrence]) – List of recurrences.

class azure.mgmt.alertsmanagement.models.Severity(value)[source]

Bases: str, enum.Enum

Severity.

SEV0 = 'Sev0'
SEV1 = 'Sev1'
SEV2 = 'Sev2'
SEV3 = 'Sev3'
SEV4 = 'Sev4'
class azure.mgmt.alertsmanagement.models.SignalType(value)[source]

Bases: str, enum.Enum

The type of signal the alert is based on, which could be metrics, logs or activity logs.

LOG = 'Log'
METRIC = 'Metric'
UNKNOWN = 'Unknown'
class azure.mgmt.alertsmanagement.models.SmartGroup(*, alerts_count: Optional[int] = None, resources: Optional[List[_models.SmartGroupAggregatedProperty]] = None, resource_types: Optional[List[_models.SmartGroupAggregatedProperty]] = None, resource_groups: Optional[List[_models.SmartGroupAggregatedProperty]] = None, monitor_services: Optional[List[_models.SmartGroupAggregatedProperty]] = None, monitor_conditions: Optional[List[_models.SmartGroupAggregatedProperty]] = None, alert_states: Optional[List[_models.SmartGroupAggregatedProperty]] = None, alert_severities: Optional[List[_models.SmartGroupAggregatedProperty]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement.models._models_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.

  • alerts_count (int) – Total number of alerts in smart group.

  • smart_group_state (str or State) – Smart group state. Known values are: “New”, “Acknowledged”, and “Closed”.

  • severity (str or Severity) – Severity of smart group is the highest(Sev0 >… > Sev4) severity of all the alerts in the group. Known values are: “Sev0”, “Sev1”, “Sev2”, “Sev3”, and “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.

  • 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.

Keyword Arguments
class azure.mgmt.alertsmanagement.models.SmartGroupAggregatedProperty(*, name: Optional[str] = None, count: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Aggregated property of each type.

Variables

  • name (str) – Name of the type.

  • count (int) – Total number of items of type.

Keyword Arguments

  • name (str) – Name of the type.

  • count (int) – Total number of items of type.

class azure.mgmt.alertsmanagement.models.SmartGroupModification(*, properties: Optional[_models.SmartGroupModificationProperties] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement.models._models_py3.Resource

Alert Modification details.

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

Variables
Keyword Arguments

properties (SmartGroupModificationProperties) – Properties of the smartGroup modification item.

class azure.mgmt.alertsmanagement.models.SmartGroupModificationEvent(value)[source]

Bases: str, enum.Enum

Reason for the modification.

ALERT_ADDED = 'AlertAdded'
ALERT_REMOVED = 'AlertRemoved'
SMART_GROUP_CREATED = 'SmartGroupCreated'
STATE_CHANGE = 'StateChange'
class azure.mgmt.alertsmanagement.models.SmartGroupModificationItem(*, modification_event: Optional[Union[str, _models.SmartGroupModificationEvent]] = None, old_value: Optional[str] = None, new_value: Optional[str] = None, modified_at: Optional[str] = None, modified_by: Optional[str] = None, comments: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

smartGroup modification item.

Variables

  • modification_event (str or SmartGroupModificationEvent) – Reason for the modification. Known values are: “SmartGroupCreated”, “StateChange”, “AlertAdded”, and “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.

Keyword Arguments

  • modification_event (str or SmartGroupModificationEvent) – Reason for the modification. Known values are: “SmartGroupCreated”, “StateChange”, “AlertAdded”, and “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: Optional[List[_models.SmartGroupModificationItem]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._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.

  • modifications (list[SmartGroupModificationItem]) – Modification details.

  • next_link (str) – URL to fetch the next set of results.

Keyword Arguments
class azure.mgmt.alertsmanagement.models.SmartGroupsList(*, next_link: Optional[str] = None, value: Optional[List[_models.SmartGroup]] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

List the alerts.

Variables

  • next_link (str) – URL to fetch the next set of alerts.

  • value (list[SmartGroup]) – List of alerts.

Keyword Arguments

  • next_link (str) – URL to fetch the next set of alerts.

  • value (list[SmartGroup]) – List of alerts.

class azure.mgmt.alertsmanagement.models.SmartGroupsSortByFields(value)[source]

Bases: str, enum.Enum

SmartGroupsSortByFields.

ALERTS_COUNT = 'alertsCount'
LAST_MODIFIED_DATE_TIME = 'lastModifiedDateTime'
SEVERITY = 'severity'
START_DATE_TIME = 'startDateTime'
STATE = 'state'
class azure.mgmt.alertsmanagement.models.SortOrder(value)[source]

Bases: str, enum.Enum

SortOrder.

ASC = 'asc'
DESC = 'desc'
class azure.mgmt.alertsmanagement.models.State(value)[source]

Bases: str, enum.Enum

Smart group state.

ACKNOWLEDGED = 'Acknowledged'
CLOSED = 'Closed'
NEW = 'New'
class azure.mgmt.alertsmanagement.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement._serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.alertsmanagement.models.TimeRange(value)[source]

Bases: str, enum.Enum

TimeRange.

ONE_D = '1d'
ONE_H = '1h'
SEVEN_D = '7d'
THIRTY_D = '30d'
class azure.mgmt.alertsmanagement.models.WeeklyRecurrence(*, days_of_week: List[Union[str, _models.DaysOfWeek]], start_time: Optional[str] = None, end_time: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.alertsmanagement.models._models_py3.Recurrence

Weekly recurrence object.

All required parameters must be populated in order to send to Azure.

Variables

  • recurrence_type (str or RecurrenceType) – Specifies when the recurrence should be applied. Required. Known values are: “Daily”, “Weekly”, and “Monthly”.

  • start_time (str) – Start time for recurrence.

  • end_time (str) – End time for recurrence.

  • days_of_week (list[str or DaysOfWeek]) – Specifies the values for weekly recurrence pattern. Required.

Keyword Arguments

  • start_time (str) – Start time for recurrence.

  • end_time (str) – End time for recurrence.

  • days_of_week (list[str or DaysOfWeek]) – Specifies the values for weekly recurrence pattern. Required.