azure.mgmt.monitor.models module

class azure.mgmt.monitor.models.Resource(*, location: str, tags=None, **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.

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

Variables
  • id (str) – Azure resource Id

  • name (str) – Azure resource name

  • type (str) – Azure resource type

Parameters
  • location (str) – Required. Resource location

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

class azure.mgmt.monitor.models.ScaleCapacity(*, minimum: str, maximum: str, default: str, **kwargs)[source]

Bases: msrest.serialization.Model

The number of instances that can be used during this profile.

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

Parameters
  • minimum (str) – Required. the minimum number of instances for the resource.

  • maximum (str) – Required. the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription.

  • default (str) – Required. the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default.

class azure.mgmt.monitor.models.MetricTrigger(*, metric_name: str, metric_resource_uri: str, time_grain, statistic, time_window, time_aggregation, operator, threshold: float, **kwargs)[source]

Bases: msrest.serialization.Model

The trigger that results in a scaling action.

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

Parameters
  • metric_name (str) – Required. the name of the metric that defines what the rule monitors.

  • metric_resource_uri (str) – Required. the resource identifier of the resource the rule monitors.

  • time_grain (timedelta) – Required. the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute.

  • statistic (str or MetricStatisticType) – Required. the metric statistic type. How the metrics from multiple instances are combined. Possible values include: ‘Average’, ‘Min’, ‘Max’, ‘Sum’

  • time_window (timedelta) – Required. the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes.

  • time_aggregation (str or TimeAggregationType) – Required. time aggregation type. How the data that is collected should be combined over time. The default value is Average. Possible values include: ‘Average’, ‘Minimum’, ‘Maximum’, ‘Total’, ‘Count’

  • operator (str or ComparisonOperationType) – Required. the operator that is used to compare the metric data and the threshold. Possible values include: ‘Equals’, ‘NotEquals’, ‘GreaterThan’, ‘GreaterThanOrEqual’, ‘LessThan’, ‘LessThanOrEqual’

  • threshold (float) – Required. the threshold of the metric that triggers the scale action.

class azure.mgmt.monitor.models.ScaleAction(*, direction, type, cooldown, value: str = '1', **kwargs)[source]

Bases: msrest.serialization.Model

The parameters for the scaling action.

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

Parameters
  • direction (str or ScaleDirection) – Required. the scale direction. Whether the scaling action increases or decreases the number of instances. Possible values include: ‘None’, ‘Increase’, ‘Decrease’

  • type (str or ScaleType) – Required. the type of action that should occur when the scale rule fires. Possible values include: ‘ChangeCount’, ‘PercentChangeCount’, ‘ExactCount’

  • value (str) – the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. Default value: “1” .

  • cooldown (timedelta) – Required. the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format.

class azure.mgmt.monitor.models.ScaleRule(*, metric_trigger, scale_action, **kwargs)[source]

Bases: msrest.serialization.Model

A rule that provide the triggers and parameters for the scaling action.

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

Parameters
  • metric_trigger (MetricTrigger) – Required. the trigger that results in a scaling action.

  • scale_action (ScaleAction) – Required. the parameters for the scaling action.

class azure.mgmt.monitor.models.TimeWindow(*, start, end, time_zone: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A specific date-time for the profile.

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

Parameters
  • time_zone (str) – the timezone of the start and end times for the profile. Some examples of valid timezones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time

  • start (datetime) – Required. the start time for the profile in ISO 8601 format.

  • end (datetime) – Required. the end time for the profile in ISO 8601 format.

class azure.mgmt.monitor.models.RecurrentSchedule(*, time_zone: str, days, hours, minutes, **kwargs)[source]

Bases: msrest.serialization.Model

The scheduling constraints for when the profile begins.

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

Parameters
  • time_zone (str) – Required. the timezone for the hours of the profile. Some examples of valid timezones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time

  • days (list[str]) – Required. the collection of days that the profile takes effect on. Possible values are Sunday through Saturday.

  • hours (list[int]) – Required. A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported).

  • minutes (list[int]) – Required. A collection of minutes at which the profile takes effect at.

class azure.mgmt.monitor.models.Recurrence(*, frequency, schedule, **kwargs)[source]

Bases: msrest.serialization.Model

The repeating times at which this profile begins. This element is not used if the FixedDate element is used.

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

Parameters
  • frequency (str or RecurrenceFrequency) – Required. the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. Possible values include: ‘None’, ‘Second’, ‘Minute’, ‘Hour’, ‘Day’, ‘Week’, ‘Month’, ‘Year’

  • schedule (RecurrentSchedule) – Required. the scheduling constraints for when the profile begins.

class azure.mgmt.monitor.models.AutoscaleProfile(*, name: str, capacity, rules, fixed_date=None, recurrence=None, **kwargs)[source]

Bases: msrest.serialization.Model

Autoscale profile.

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

Parameters
  • name (str) – Required. the name of the profile.

  • capacity (ScaleCapacity) – Required. the number of instances that can be used during this profile.

  • rules (list[ScaleRule]) – Required. the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified.

  • fixed_date (TimeWindow) – the specific date-time for the profile. This element is not used if the Recurrence element is used.

  • recurrence (Recurrence) – the repeating times at which this profile begins. This element is not used if the FixedDate element is used.

class azure.mgmt.monitor.models.EmailNotification(*, send_to_subscription_administrator: bool = None, send_to_subscription_co_administrators: bool = None, custom_emails=None, **kwargs)[source]

Bases: msrest.serialization.Model

Email notification of an autoscale event.

Parameters
  • send_to_subscription_administrator (bool) – a value indicating whether to send email to subscription administrator.

  • send_to_subscription_co_administrators (bool) – a value indicating whether to send email to subscription co-administrators.

  • custom_emails (list[str]) – the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored.

class azure.mgmt.monitor.models.WebhookNotification(*, service_uri: str = None, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Webhook notification of an autoscale event.

Parameters
  • service_uri (str) – the service address to receive the notification.

  • properties (dict[str, str]) – a property bag of settings. This value can be empty.

class azure.mgmt.monitor.models.AutoscaleNotification(*, email=None, webhooks=None, **kwargs)[source]

Bases: msrest.serialization.Model

Autoscale notification.

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

operation (str) – Required. the operation associated with the notification and its value must be “scale”. Default value: “Scale” .

Parameters
operation = 'Scale'
class azure.mgmt.monitor.models.AutoscaleSettingResource(*, location: str, profiles, tags=None, notifications=None, enabled: bool = True, autoscale_setting_resource_name: str = None, target_resource_uri: str = None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.resource_py3.Resource

The autoscale setting resource.

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

  • name (str) – Azure resource name

  • type (str) – Azure resource type

Parameters
  • location (str) – Required. Resource location

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

  • profiles (list[AutoscaleProfile]) – Required. the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified.

  • notifications (list[AutoscaleNotification]) – the collection of notifications.

  • enabled (bool) – the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is ‘true’. Default value: True .

  • autoscale_setting_resource_name (str) – the name of the autoscale setting.

  • target_resource_uri (str) – the resource identifier of the resource that the autoscale setting should be added to.

class azure.mgmt.monitor.models.AutoscaleSettingResourcePatch(*, profiles, tags=None, notifications=None, enabled: bool = True, name: str = None, target_resource_uri: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The autoscale setting object for patch operations.

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

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

  • profiles (list[AutoscaleProfile]) – Required. the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified.

  • notifications (list[AutoscaleNotification]) – the collection of notifications.

  • enabled (bool) – the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is ‘true’. Default value: True .

  • name (str) – the name of the autoscale setting.

  • target_resource_uri (str) – the resource identifier of the resource that the autoscale setting should be added to.

class azure.mgmt.monitor.models.ErrorResponse(*, code: str = None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes the format of Error response.

Parameters
  • code (str) – Error code

  • message (str) – Error message indicating why the operation failed.

exception azure.mgmt.monitor.models.ErrorResponseException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorResponse’.

Parameters
  • deserialize – A deserializer

  • response – Server response to be deserialized.

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

Bases: msrest.serialization.Model

Display metadata associated with the operation.

Parameters
  • provider (str) – Service provider: Microsoft.Insights

  • resource (str) – Resource on which the operation is performed: AlertRules, Autoscale, etc.

  • operation (str) – Operation type: Read, write, delete, etc.

class azure.mgmt.monitor.models.Operation(*, name: str = None, display=None, **kwargs)[source]

Bases: msrest.serialization.Model

Microsoft Insights API operation definition.

Parameters
  • name (str) – Operation name: {provider}/{resource}/{operation}

  • display (OperationDisplay) – Display metadata associated with the operation.

class azure.mgmt.monitor.models.OperationListResult(*, value=None, next_link: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Result of the request to list Microsoft.Insights operations. It contains a list of operations and a URL link to get the next set of results.

Parameters
  • value (list[Operation]) – List of operations supported by the Microsoft.Insights provider.

  • next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.monitor.models.Incident(**kwargs)[source]

Bases: msrest.serialization.Model

An alert incident indicates the activation status of an alert rule.

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

Variables
  • name (str) – Incident name.

  • rule_name (str) – Rule name that is associated with the incident.

  • is_active (bool) – A boolean to indicate whether the incident is active or resolved.

  • activated_time (datetime) – The time at which the incident was activated in ISO8601 format.

  • resolved_time (datetime) – The time at which the incident was resolved in ISO8601 format. If null, it means the incident is still active.

class azure.mgmt.monitor.models.RuleDataSource(*, resource_uri: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The resource from which the rule collects its data.

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

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

Parameters
  • resource_uri (str) – the resource identifier of the resource the rule monitors. NOTE: this property cannot be updated for an existing rule.

  • odatatype (str) – Required. Constant filled by server.

class azure.mgmt.monitor.models.RuleCondition(*, data_source=None, **kwargs)[source]

Bases: msrest.serialization.Model

The condition that results in the alert rule being activated.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ThresholdRuleCondition, LocationThresholdRuleCondition, ManagementEventRuleCondition

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

Parameters
  • data_source (RuleDataSource) – the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource.

  • odatatype (str) – Required. Constant filled by server.

class azure.mgmt.monitor.models.RuleMetricDataSource(*, resource_uri: str = None, metric_name: str = None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.rule_data_source_py3.RuleDataSource

A rule metric data source. The discriminator value is always RuleMetricDataSource in this case.

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

Parameters
  • resource_uri (str) – the resource identifier of the resource the rule monitors. NOTE: this property cannot be updated for an existing rule.

  • odatatype (str) – Required. Constant filled by server.

  • metric_name (str) – the name of the metric that defines what the rule monitors.

class azure.mgmt.monitor.models.RuleManagementEventClaimsDataSource(*, email_address: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The claims for a rule management event data source.

Parameters

email_address (str) – the email address.

class azure.mgmt.monitor.models.RuleManagementEventDataSource(*, resource_uri: str = None, event_name: str = None, event_source: str = None, level: str = None, operation_name: str = None, resource_group_name: str = None, resource_provider_name: str = None, status: str = None, sub_status: str = None, claims=None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.rule_data_source_py3.RuleDataSource

A rule management event data source. The discriminator fields is always RuleManagementEventDataSource in this case.

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

Parameters
  • resource_uri (str) – the resource identifier of the resource the rule monitors. NOTE: this property cannot be updated for an existing rule.

  • odatatype (str) – Required. Constant filled by server.

  • event_name (str) – the event name.

  • event_source (str) – the event source.

  • level (str) – the level.

  • operation_name (str) – The name of the operation that should be checked for. If no name is provided, any operation will match.

  • resource_group_name (str) – the resource group name.

  • resource_provider_name (str) – the resource provider name.

  • status (str) – The status of the operation that should be checked for. If no status is provided, any status will match.

  • sub_status (str) – the substatus.

  • claims (RuleManagementEventClaimsDataSource) – the claims.

class azure.mgmt.monitor.models.ThresholdRuleCondition(*, operator, threshold: float, data_source=None, window_size=None, time_aggregation=None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.rule_condition_py3.RuleCondition

A rule condition based on a metric crossing a threshold.

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

Parameters
  • data_source (RuleDataSource) – the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource.

  • odatatype (str) – Required. Constant filled by server.

  • operator (str or ConditionOperator) – Required. the operator used to compare the data and the threshold. Possible values include: ‘GreaterThan’, ‘GreaterThanOrEqual’, ‘LessThan’, ‘LessThanOrEqual’

  • threshold (float) – Required. the threshold value that activates the alert.

  • window_size (timedelta) – the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.

  • time_aggregation (str or TimeAggregationOperator) – the time aggregation operator. How the data that are collected should be combined over time. The default value is the PrimaryAggregationType of the Metric. Possible values include: ‘Average’, ‘Minimum’, ‘Maximum’, ‘Total’, ‘Last’

class azure.mgmt.monitor.models.LocationThresholdRuleCondition(*, failed_location_count: int, data_source=None, window_size=None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.rule_condition_py3.RuleCondition

A rule condition based on a certain number of locations failing.

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

Parameters
  • data_source (RuleDataSource) – the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource.

  • odatatype (str) – Required. Constant filled by server.

  • window_size (timedelta) – the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.

  • failed_location_count (int) – Required. the number of locations that must fail to activate the alert.

class azure.mgmt.monitor.models.ManagementEventAggregationCondition(*, operator=None, threshold: float = None, window_size=None, **kwargs)[source]

Bases: msrest.serialization.Model

How the data that is collected should be combined over time.

Parameters
  • operator (str or ConditionOperator) – the condition operator. Possible values include: ‘GreaterThan’, ‘GreaterThanOrEqual’, ‘LessThan’, ‘LessThanOrEqual’

  • threshold (float) – The threshold value that activates the alert.

  • window_size (timedelta) – the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.

class azure.mgmt.monitor.models.ManagementEventRuleCondition(*, data_source=None, aggregation=None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.rule_condition_py3.RuleCondition

A management event rule condition.

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

Parameters
  • data_source (RuleDataSource) – the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource.

  • odatatype (str) – Required. Constant filled by server.

  • aggregation (ManagementEventAggregationCondition) – How the data that is collected should be combined over time and when the alert is activated. Note that for management event alerts aggregation is optional – if it is not provided then any event will cause the alert to activate.

class azure.mgmt.monitor.models.RuleAction(**kwargs)[source]

Bases: msrest.serialization.Model

The action that is performed when the alert rule becomes active, and when an alert condition is resolved.

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

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

Parameters

odatatype (str) – Required. Constant filled by server.

class azure.mgmt.monitor.models.RuleEmailAction(*, send_to_service_owners: bool = None, custom_emails=None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.rule_action_py3.RuleAction

Specifies the action to send email when the rule condition is evaluated. The discriminator is always RuleEmailAction in this case.

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

Parameters
  • odatatype (str) – Required. Constant filled by server.

  • send_to_service_owners (bool) – Whether the administrators (service and co-administrators) of the service should be notified when the alert is activated.

  • custom_emails (list[str]) – the list of administrator’s custom email addresses to notify of the activation of the alert.

class azure.mgmt.monitor.models.RuleWebhookAction(*, service_uri: str = None, properties=None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.rule_action_py3.RuleAction

Specifies the action to post to service when the rule condition is evaluated. The discriminator is always RuleWebhookAction in this case.

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

Parameters
  • odatatype (str) – Required. Constant filled by server.

  • service_uri (str) – the service uri to Post the notification when the alert activates or resolves.

  • properties (dict[str, str]) – the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload.

class azure.mgmt.monitor.models.AlertRuleResource(*, location: str, alert_rule_resource_name: str, is_enabled: bool, condition, tags=None, description: str = None, actions=None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.resource_py3.Resource

The alert rule resource.

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

  • name (str) – Azure resource name

  • type (str) – Azure resource type

  • last_updated_time (datetime) – Last time the rule was updated in ISO8601 format.

Parameters
  • location (str) – Required. Resource location

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

  • alert_rule_resource_name (str) – Required. the name of the alert rule.

  • description (str) – the description of the alert rule that will be included in the alert email.

  • is_enabled (bool) – Required. the flag that indicates whether the alert rule is enabled.

  • condition (RuleCondition) – Required. the condition that results in the alert rule being activated.

  • actions (list[RuleAction]) – the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.

class azure.mgmt.monitor.models.AlertRuleResourcePatch(*, name: str, is_enabled: bool, condition, tags=None, description: str = None, actions=None, **kwargs)[source]

Bases: msrest.serialization.Model

The alert rule object for patch operations.

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.

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

  • name (str) – Required. the name of the alert rule.

  • description (str) – the description of the alert rule that will be included in the alert email.

  • is_enabled (bool) – Required. the flag that indicates whether the alert rule is enabled.

  • condition (RuleCondition) – Required. the condition that results in the alert rule being activated.

  • actions (list[RuleAction]) – the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.

Variables

last_updated_time (datetime) – Last time the rule was updated in ISO8601 format.

class azure.mgmt.monitor.models.RetentionPolicy(*, enabled: bool, days: int, **kwargs)[source]

Bases: msrest.serialization.Model

Specifies the retention policy for the log.

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

Parameters
  • enabled (bool) – Required. a value indicating whether the retention policy is enabled.

  • days (int) – Required. the number of days for the retention in days. A value of 0 will retain the events indefinitely.

class azure.mgmt.monitor.models.LogProfileResource(*, location: str, locations, categories, retention_policy, tags=None, storage_account_id: str = None, service_bus_rule_id: str = None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.resource_py3.Resource

The log profile resource.

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

  • name (str) – Azure resource name

  • type (str) – Azure resource type

Parameters
  • location (str) – Required. Resource location

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

  • storage_account_id (str) – the resource id of the storage account to which you would like to send the Activity Log.

  • service_bus_rule_id (str) – The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming the Activity Log. The rule ID is of the format: ‘{service bus resource ID}/authorizationrules/{key name}’.

  • locations (list[str]) – Required. List of regions for which Activity Log events should be stored or streamed. It is a comma separated list of valid ARM locations including the ‘global’ location.

  • categories (list[str]) – Required. the categories of the logs. These categories are created as is convenient to the user. Some values are: ‘Write’, ‘Delete’, and/or ‘Action.’

  • retention_policy (RetentionPolicy) – Required. the retention policy for the events in the log.

class azure.mgmt.monitor.models.LogProfileResourcePatch(*, locations, categories, retention_policy, tags=None, storage_account_id: str = None, service_bus_rule_id: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The log profile resource for patch operations.

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

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

  • storage_account_id (str) – the resource id of the storage account to which you would like to send the Activity Log.

  • service_bus_rule_id (str) – The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming the Activity Log. The rule ID is of the format: ‘{service bus resource ID}/authorizationrules/{key name}’.

  • locations (list[str]) – Required. List of regions for which Activity Log events should be stored or streamed. It is a comma separated list of valid ARM locations including the ‘global’ location.

  • categories (list[str]) – Required. the categories of the logs. These categories are created as is convenient to the user. Some values are: ‘Write’, ‘Delete’, and/or ‘Action.’

  • retention_policy (RetentionPolicy) – Required. the retention policy for the events in the log.

class azure.mgmt.monitor.models.ProxyOnlyResource(**kwargs)[source]

Bases: msrest.serialization.Model

A proxy only azure resource object.

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

Variables
  • id (str) – Azure resource Id

  • name (str) – Azure resource name

  • type (str) – Azure resource type

class azure.mgmt.monitor.models.MetricSettings(*, enabled: bool, time_grain=None, category: str = None, retention_policy=None, **kwargs)[source]

Bases: msrest.serialization.Model

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular metric.

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

Parameters
  • time_grain (timedelta) – the timegrain of the metric in ISO8601 format.

  • category (str) – Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation.

  • enabled (bool) – Required. a value indicating whether this category is enabled.

  • retention_policy (RetentionPolicy) – the retention policy for this category.

class azure.mgmt.monitor.models.LogSettings(*, enabled: bool, category: str = None, retention_policy=None, **kwargs)[source]

Bases: msrest.serialization.Model

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log.

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

Parameters
  • category (str) – Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.

  • enabled (bool) – Required. a value indicating whether this log is enabled.

  • retention_policy (RetentionPolicy) – the retention policy for this log.

class azure.mgmt.monitor.models.DiagnosticSettingsResource(*, storage_account_id: str = None, event_hub_authorization_rule_id: str = None, event_hub_name: str = None, metrics=None, logs=None, workspace_id: str = None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.proxy_only_resource_py3.ProxyOnlyResource

The diagnostic setting resource.

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

Variables
  • id (str) – Azure resource Id

  • name (str) – Azure resource name

  • type (str) – Azure resource type

Parameters
  • storage_account_id (str) – The resource ID of the storage account to which you would like to send Diagnostic Logs.

  • event_hub_authorization_rule_id (str) – The resource Id for the event hub authorization rule.

  • event_hub_name (str) – The name of the event hub. If none is specified, the default event hub will be selected.

  • metrics (list[MetricSettings]) – the list of metric settings.

  • logs (list[LogSettings]) – the list of logs settings.

  • workspace_id (str) – The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

class azure.mgmt.monitor.models.DiagnosticSettingsResourceCollection(*, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

Represents a collection of alert rule resources.

Parameters

value (list[DiagnosticSettingsResource]) – The collection of diagnostic settings resources;.

class azure.mgmt.monitor.models.DiagnosticSettingsCategoryResource(*, category_type=None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.proxy_only_resource_py3.ProxyOnlyResource

The diagnostic settings category resource.

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

Variables
  • id (str) – Azure resource Id

  • name (str) – Azure resource name

  • type (str) – Azure resource type

Parameters

category_type (str or CategoryType) – The type of the diagnostic settings category. Possible values include: ‘Metrics’, ‘Logs’

class azure.mgmt.monitor.models.DiagnosticSettingsCategoryResourceCollection(*, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

Represents a collection of diagnostic setting category resources.

Parameters

value (list[DiagnosticSettingsCategoryResource]) – The collection of diagnostic settings category resources.

class azure.mgmt.monitor.models.EmailReceiver(*, name: str, email_address: str, **kwargs)[source]

Bases: msrest.serialization.Model

An email receiver.

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.

Parameters
  • name (str) – Required. The name of the email receiver. Names must be unique across all receivers within an action group.

  • email_address (str) – Required. The email address of this receiver.

Variables

status (str or ReceiverStatus) – The receiver status of the e-mail. Possible values include: ‘NotSpecified’, ‘Enabled’, ‘Disabled’

class azure.mgmt.monitor.models.SmsReceiver(*, name: str, country_code: str, phone_number: str, **kwargs)[source]

Bases: msrest.serialization.Model

An SMS receiver.

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.

Parameters
  • name (str) – Required. The name of the SMS receiver. Names must be unique across all receivers within an action group.

  • country_code (str) – Required. The country code of the SMS receiver.

  • phone_number (str) – Required. The phone number of the SMS receiver.

Variables

status (str or ReceiverStatus) – The status of the receiver. Possible values include: ‘NotSpecified’, ‘Enabled’, ‘Disabled’

class azure.mgmt.monitor.models.WebhookReceiver(*, name: str, service_uri: str, **kwargs)[source]

Bases: msrest.serialization.Model

A webhook receiver.

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

Parameters
  • name (str) – Required. The name of the webhook receiver. Names must be unique across all receivers within an action group.

  • service_uri (str) – Required. The URI where webhooks should be sent.

class azure.mgmt.monitor.models.ItsmReceiver(*, name: str, workspace_id: str, connection_id: str, ticket_configuration: str, region: str, **kwargs)[source]

Bases: msrest.serialization.Model

An Itsm receiver.

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

Parameters
  • name (str) – Required. The name of the Itsm receiver. Names must be unique across all receivers within an action group.

  • workspace_id (str) – Required. OMS LA instance identifier.

  • connection_id (str) – Required. Unique identification of ITSM connection among multiple defined in above workspace.

  • ticket_configuration (str) – Required. JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.

  • region (str) – Required. Region in which workspace resides. Supported values:’centralindia’,’japaneast’,’southeastasia’,’australiasoutheast’,’uksouth’,’westcentralus’,’canadacentral’,’eastus’,’westeurope’

class azure.mgmt.monitor.models.AzureAppPushReceiver(*, name: str, email_address: str, **kwargs)[source]

Bases: msrest.serialization.Model

The Azure mobile App push notification receiver.

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

Parameters
  • name (str) – Required. The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group.

  • email_address (str) – Required. The email address registered for the Azure mobile app.

class azure.mgmt.monitor.models.AutomationRunbookReceiver(*, automation_account_id: str, runbook_name: str, webhook_resource_id: str, is_global_runbook: bool, name: str = None, service_uri: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The Azure Automation Runbook notification receiver.

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

Parameters
  • automation_account_id (str) – Required. The Azure automation account Id which holds this runbook and authenticate to Azure resource.

  • runbook_name (str) – Required. The name for this runbook.

  • webhook_resource_id (str) – Required. The resource id for webhook linked to this runbook.

  • is_global_runbook (bool) – Required. Indicates whether this instance is global runbook.

  • name (str) – Indicates name of the webhook.

  • service_uri (str) – The URI where webhooks should be sent.

class azure.mgmt.monitor.models.VoiceReceiver(*, name: str, country_code: str, phone_number: str, **kwargs)[source]

Bases: msrest.serialization.Model

A voice receiver.

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

Parameters
  • name (str) – Required. The name of the voice receiver. Names must be unique across all receivers within an action group.

  • country_code (str) – Required. The country code of the voice receiver.

  • phone_number (str) – Required. The phone number of the voice receiver.

class azure.mgmt.monitor.models.LogicAppReceiver(*, name: str, resource_id: str, callback_url: str, **kwargs)[source]

Bases: msrest.serialization.Model

A logic app receiver.

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

Parameters
  • name (str) – Required. The name of the logic app receiver. Names must be unique across all receivers within an action group.

  • resource_id (str) – Required. The azure resource id of the logic app receiver.

  • callback_url (str) – Required. The callback url where http request sent to.

class azure.mgmt.monitor.models.AzureFunctionReceiver(*, name: str, function_app_resource_id: str, function_name: str, http_trigger_url: str, **kwargs)[source]

Bases: msrest.serialization.Model

An azure function receiver.

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

Parameters
  • name (str) – Required. The name of the azure function receiver. Names must be unique across all receivers within an action group.

  • function_app_resource_id (str) – Required. The azure resource id of the function app.

  • function_name (str) – Required. The function name in the function app.

  • http_trigger_url (str) – Required. The http trigger url where http request sent to.

class azure.mgmt.monitor.models.ActionGroupResource(*, location: str, group_short_name: str, tags=None, enabled: bool = True, email_receivers=None, sms_receivers=None, webhook_receivers=None, itsm_receivers=None, azure_app_push_receivers=None, automation_runbook_receivers=None, voice_receivers=None, logic_app_receivers=None, azure_function_receivers=None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.resource_py3.Resource

An action group resource.

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

  • name (str) – Azure resource name

  • type (str) – Azure resource type

Parameters
  • location (str) – Required. Resource location

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

  • group_short_name (str) – Required. The short name of the action group. This will be used in SMS messages.

  • enabled (bool) – Required. Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Default value: True .

  • email_receivers (list[EmailReceiver]) – The list of email receivers that are part of this action group.

  • sms_receivers (list[SmsReceiver]) – The list of SMS receivers that are part of this action group.

  • webhook_receivers (list[WebhookReceiver]) – The list of webhook receivers that are part of this action group.

  • itsm_receivers (list[ItsmReceiver]) – The list of ITSM receivers that are part of this action group.

  • azure_app_push_receivers (list[AzureAppPushReceiver]) – The list of AzureAppPush receivers that are part of this action group.

  • automation_runbook_receivers (list[AutomationRunbookReceiver]) – The list of AutomationRunbook receivers that are part of this action group.

  • voice_receivers (list[VoiceReceiver]) – The list of voice receivers that are part of this action group.

  • logic_app_receivers (list[LogicAppReceiver]) – The list of logic app receivers that are part of this action group.

  • azure_function_receivers (list[AzureFunctionReceiver]) – The list of azure function receivers that are part of this action group.

class azure.mgmt.monitor.models.EnableRequest(*, receiver_name: str, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a receiver that should be resubscribed.

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

Parameters

receiver_name (str) – Required. The name of the receiver to resubscribe.

class azure.mgmt.monitor.models.ActionGroupPatchBody(*, tags=None, enabled: bool = True, **kwargs)[source]

Bases: msrest.serialization.Model

An action group object for the body of patch operations.

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

  • enabled (bool) – Indicates whether this action group is enabled. If an action group is not enabled, then none of its actions will be activated. Default value: True .

class azure.mgmt.monitor.models.ActivityLogAlertLeafCondition(*, field: str, equals: str, **kwargs)[source]

Bases: msrest.serialization.Model

An Activity Log alert condition that is met by comparing an activity log field and value.

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

Parameters
  • field (str) – Required. The name of the field that this condition will examine. The possible values for this field are (case-insensitive): ‘resourceId’, ‘category’, ‘caller’, ‘level’, ‘operationName’, ‘resourceGroup’, ‘resourceProvider’, ‘status’, ‘subStatus’, ‘resourceType’, or anything beginning with ‘properties.’.

  • equals (str) – Required. The field value will be compared to this value (case-insensitive) to determine if the condition is met.

class azure.mgmt.monitor.models.ActivityLogAlertAllOfCondition(*, all_of, **kwargs)[source]

Bases: msrest.serialization.Model

An Activity Log alert condition that is met when all its member conditions are met.

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

Parameters

all_of (list[ActivityLogAlertLeafCondition]) – Required. The list of activity log alert conditions.

class azure.mgmt.monitor.models.ActivityLogAlertActionGroup(*, action_group_id: str, webhook_properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

A pointer to an Azure Action Group.

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

Parameters
  • action_group_id (str) – Required. The resourceId of the action group. This cannot be null or empty.

  • webhook_properties (dict[str, str]) – the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload.

class azure.mgmt.monitor.models.ActivityLogAlertActionList(*, action_groups=None, **kwargs)[source]

Bases: msrest.serialization.Model

A list of activity log alert actions.

Parameters

action_groups (list[ActivityLogAlertActionGroup]) – The list of activity log alerts.

class azure.mgmt.monitor.models.ActivityLogAlertResource(*, location: str, scopes, condition, actions, tags=None, enabled: bool = True, description: str = None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.resource_py3.Resource

An activity log alert resource.

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

  • name (str) – Azure resource name

  • type (str) – Azure resource type

Parameters
  • location (str) – Required. Resource location

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

  • scopes (list[str]) – Required. A list of resourceIds that will be used as prefixes. The alert will only apply to activityLogs with resourceIds that fall under one of these prefixes. This list must include at least one item.

  • enabled (bool) – Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated. Default value: True .

  • condition (ActivityLogAlertAllOfCondition) – Required. The condition that will cause this alert to activate.

  • actions (ActivityLogAlertActionList) – Required. The actions that will activate when the condition is met.

  • description (str) – A description of this activity log alert.

class azure.mgmt.monitor.models.ActivityLogAlertPatchBody(*, tags=None, enabled: bool = True, **kwargs)[source]

Bases: msrest.serialization.Model

An activity log alert object for the body of patch operations.

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

  • enabled (bool) – Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated. Default value: True .

class azure.mgmt.monitor.models.LocalizableString(*, value: str, localized_value: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The localizable string class.

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

Parameters
  • value (str) – Required. the invariant value.

  • localized_value (str) – the locale specific value.

class azure.mgmt.monitor.models.SenderAuthorization(*, action: str = None, role: str = None, scope: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

the authorization used by the user who has performed the operation that led to this event. This captures the RBAC properties of the event. These usually include the ‘action’, ‘role’ and the ‘scope’.

Parameters
  • action (str) – the permissible actions. For instance: microsoft.support/supporttickets/write

  • role (str) – the role of the user. For instance: Subscription Admin

  • scope (str) – the scope.

class azure.mgmt.monitor.models.HttpRequestInfo(*, client_request_id: str = None, client_ip_address: str = None, method: str = None, uri: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The Http request info.

Parameters
  • client_request_id (str) – the client request id.

  • client_ip_address (str) – the client Ip Address

  • method (str) – the Http request method.

  • uri (str) – the Uri.

class azure.mgmt.monitor.models.EventData(**kwargs)[source]

Bases: msrest.serialization.Model

The Azure event log entries are of type EventData.

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

Variables
  • authorization (SenderAuthorization) –

  • claims (dict[str, str]) – key value pairs to identify ARM permissions.

  • caller (str) – the email address of the user who has performed the operation, the UPN claim or SPN claim based on availability.

  • description (str) – the description of the event.

  • id (str) – the Id of this event as required by ARM for RBAC. It contains the EventDataID and a timestamp information.

  • event_data_id (str) – the event data Id. This is a unique identifier for an event.

  • correlation_id (str) – the correlation Id, usually a GUID in the string format. The correlation Id is shared among the events that belong to the same uber operation.

  • event_name (LocalizableString) – the event name. This value should not be confused with OperationName. For practical purposes, OperationName might be more appealing to end users.

  • category (LocalizableString) – the event category.

  • http_request (HttpRequestInfo) – the HTTP request info. Usually includes the ‘clientRequestId’, ‘clientIpAddress’ (IP address of the user who initiated the event) and ‘method’ (HTTP method e.g. PUT).

  • level (str or EventLevel) – the event level. Possible values include: ‘Critical’, ‘Error’, ‘Warning’, ‘Informational’, ‘Verbose’

  • resource_group_name (str) – the resource group name of the impacted resource.

  • resource_provider_name (LocalizableString) – the resource provider name of the impacted resource.

  • resource_id (str) – the resource uri that uniquely identifies the resource that caused this event.

  • resource_type (LocalizableString) – the resource type

  • operation_id (str) – It is usually a GUID shared among the events corresponding to single operation. This value should not be confused with EventName.

  • operation_name (LocalizableString) – the operation name.

  • properties (dict[str, str]) – the set of <Key, Value> pairs (usually a Dictionary<String, String>) that includes details about the event.

  • status (LocalizableString) – a string describing the status of the operation. Some typical values are: Started, In progress, Succeeded, Failed, Resolved.

  • sub_status (LocalizableString) – the event sub status. Most of the time, when included, this captures the HTTP status code of the REST call. Common values are: OK (HTTP Status Code: 200), Created (HTTP Status Code: 201), Accepted (HTTP Status Code: 202), No Content (HTTP Status Code: 204), Bad Request(HTTP Status Code: 400), Not Found (HTTP Status Code: 404), Conflict (HTTP Status Code: 409), Internal Server Error (HTTP Status Code: 500), Service Unavailable (HTTP Status Code:503), Gateway Timeout (HTTP Status Code: 504)

  • event_timestamp (datetime) – the timestamp of when the event was generated by the Azure service processing the request corresponding the event. It in ISO 8601 format.

  • submission_timestamp (datetime) – the timestamp of when the event became available for querying via this API. It is in ISO 8601 format. This value should not be confused eventTimestamp. As there might be a delay between the occurrence time of the event, and the time that the event is submitted to the Azure logging infrastructure.

  • subscription_id (str) – the Azure subscription Id usually a GUID.

  • tenant_id (str) – the Azure tenant Id

class azure.mgmt.monitor.models.MetricAvailability(*, time_grain=None, retention=None, **kwargs)[source]

Bases: msrest.serialization.Model

Metric availability specifies the time grain (aggregation interval or frequency) and the retention period for that time grain.

Parameters
  • time_grain (timedelta) – the time grain specifies the aggregation interval for the metric. Expressed as a duration ‘PT1M’, ‘P1D’, etc.

  • retention (timedelta) – the retention period for the metric at the specified timegrain. Expressed as a duration ‘PT1M’, ‘P1D’, etc.

class azure.mgmt.monitor.models.MetricDefinition(*, is_dimension_required: bool = None, resource_id: str = None, namespace: str = None, name=None, unit=None, primary_aggregation_type=None, supported_aggregation_types=None, metric_availabilities=None, id: str = None, dimensions=None, **kwargs)[source]

Bases: msrest.serialization.Model

Metric definition class specifies the metadata for a metric.

Parameters
  • is_dimension_required (bool) – Flag to indicate whether the dimension is required.

  • resource_id (str) – the resource identifier of the resource that emitted the metric.

  • namespace (str) – the namespace the metric blongs to.

  • name (LocalizableString) – the name and the display name of the metric, i.e. it is a localizable string.

  • unit (str or Unit) – the unit of the metric. Possible values include: ‘Count’, ‘Bytes’, ‘Seconds’, ‘CountPerSecond’, ‘BytesPerSecond’, ‘Percent’, ‘MilliSeconds’, ‘ByteSeconds’, ‘Unspecified’

  • primary_aggregation_type (str or AggregationType) – the primary aggregation type value defining how to use the values for display. Possible values include: ‘None’, ‘Average’, ‘Count’, ‘Minimum’, ‘Maximum’, ‘Total’

  • supported_aggregation_types (list[str or AggregationType]) – the collection of what aggregation types are supported.

  • metric_availabilities (list[MetricAvailability]) – the collection of what aggregation intervals are available to be queried.

  • id (str) – the resource identifier of the metric definition.

  • dimensions (list[LocalizableString]) – the name and the display name of the dimension, i.e. it is a localizable string.

class azure.mgmt.monitor.models.MetricValue(*, time_stamp, average: float = None, minimum: float = None, maximum: float = None, total: float = None, count: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Represents a metric value.

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

Parameters
  • time_stamp (datetime) – Required. the timestamp for the metric value in ISO 8601 format.

  • average (float) – the average value in the time range.

  • minimum (float) – the least value in the time range.

  • maximum (float) – the greatest value in the time range.

  • total (float) – the sum of all of the values in the time range.

  • count (long) – the number of samples in the time range. Can be used to determine the number of values that contributed to the average value.

class azure.mgmt.monitor.models.MetadataValue(*, name=None, value: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Represents a metric metadata value.

Parameters
  • name (LocalizableString) – the name of the metadata.

  • value (str) – the value of the metadata.

class azure.mgmt.monitor.models.TimeSeriesElement(*, metadatavalues=None, data=None, **kwargs)[source]

Bases: msrest.serialization.Model

A time series result type. The discriminator value is always TimeSeries in this case.

Parameters
  • metadatavalues (list[MetadataValue]) – the metadata values returned if $filter was specified in the call.

  • data (list[MetricValue]) – An array of data points representing the metric values. This is only returned if a result type of data is specified.

class azure.mgmt.monitor.models.Metric(*, id: str, type: str, name, unit, timeseries, **kwargs)[source]

Bases: msrest.serialization.Model

The result data of a query.

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

Parameters
  • id (str) – Required. the metric Id.

  • type (str) – Required. the resource type of the metric resource.

  • name (LocalizableString) – Required. the name and the display name of the metric, i.e. it is localizable string.

  • unit (str or Unit) – Required. the unit of the metric. Possible values include: ‘Count’, ‘Bytes’, ‘Seconds’, ‘CountPerSecond’, ‘BytesPerSecond’, ‘Percent’, ‘MilliSeconds’, ‘ByteSeconds’, ‘Unspecified’

  • timeseries (list[TimeSeriesElement]) – Required. the time series returned when a data query is performed.

class azure.mgmt.monitor.models.Response(*, timespan: str, value, cost: float = None, interval=None, namespace: str = None, resourceregion: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The response to a metrics query.

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

Parameters
  • cost (float) – The integer value representing the cost of the query, for data case.

  • timespan (str) – Required. The timespan for which the data was retrieved. Its value consists of two datatimes concatenated, separated by ‘/’. This may be adjusted in the future and returned back from what was originally requested.

  • interval (timedelta) – The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made.

  • namespace (str) – The namespace of the metrics been queried

  • resourceregion (str) – The region of the resource been queried for metrics.

  • value (list[Metric]) – Required. the value of the collection.

class azure.mgmt.monitor.models.BaselineMetadataValue(*, name=None, value: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Represents a baseline metadata value.

Parameters
  • name (LocalizableString) – the name of the metadata.

  • value (str) – the value of the metadata.

class azure.mgmt.monitor.models.Baseline(*, sensitivity, low_thresholds, high_thresholds, **kwargs)[source]

Bases: msrest.serialization.Model

The baseline values for a single sensitivity value.

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

Parameters
  • sensitivity (str or Sensitivity) – Required. the sensitivity of the baseline. Possible values include: ‘Low’, ‘Medium’, ‘High’

  • low_thresholds (list[float]) – Required. The low thresholds of the baseline.

  • high_thresholds (list[float]) – Required. The high thresholds of the baseline.

class azure.mgmt.monitor.models.BaselineResponse(*, timespan: str = None, interval=None, aggregation: str = None, timestamps=None, baseline=None, metadata=None, **kwargs)[source]

Bases: msrest.serialization.Model

The response to a baseline query.

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

Variables
  • id (str) – the metric baseline Id.

  • type (str) – the resource type of the baseline resource.

  • name (LocalizableString) – the name and the display name of the metric, i.e. it is localizable string.

Parameters
  • timespan (str) – The timespan for which the data was retrieved. Its value consists of two datatimes concatenated, separated by ‘/’. This may be adjusted in the future and returned back from what was originally requested.

  • interval (timedelta) – The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made.

  • aggregation (str) – The aggregation type of the metric.

  • timestamps (list[datetime]) – the array of timestamps of the baselines.

  • baseline (list[Baseline]) – the baseline values for each sensitivity.

  • metadata (list[BaselineMetadataValue]) – the baseline metadata values.

class azure.mgmt.monitor.models.TimeSeriesInformation(*, sensitivities, values, timestamps=None, **kwargs)[source]

Bases: msrest.serialization.Model

The time series info needed for calculating the baseline.

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

Parameters
  • sensitivities (list[str]) – Required. the list of sensitivities for calculating the baseline.

  • values (list[float]) – Required. The metric values to calculate the baseline.

  • timestamps (list[datetime]) – the array of timestamps of the baselines.

class azure.mgmt.monitor.models.CalculateBaselineResponse(*, type: str, baseline, timestamps=None, **kwargs)[source]

Bases: msrest.serialization.Model

The response to a calcualte baseline call.

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

Parameters
  • type (str) – Required. the resource type of the baseline resource.

  • timestamps (list[datetime]) – the array of timestamps of the baselines.

  • baseline (list[Baseline]) – Required. the baseline values for each sensitivity.

class azure.mgmt.monitor.models.MetricAlertAction(*, action_group_id: str = None, webhook_properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

An alert action.

Parameters
  • action_group_id (str) – the id of the action group to use.

  • webhook_properties (dict[str, str]) –

class azure.mgmt.monitor.models.MetricAlertCriteria(*, additional_properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

The rule criteria that defines the conditions of the alert rule.

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

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

Parameters
  • additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection

  • odatatype (str) – Required. Constant filled by server.

class azure.mgmt.monitor.models.MetricAlertResource(*, location: str, description: str, severity: int, enabled: bool, evaluation_frequency, window_size, criteria, tags=None, scopes=None, auto_mitigate: bool = None, actions=None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.resource_py3.Resource

The metric alert resource.

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

  • name (str) – Azure resource name

  • type (str) – Azure resource type

  • last_updated_time (datetime) – Last time the rule was updated in ISO8601 format.

Parameters
  • location (str) – Required. Resource location

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

  • description (str) – Required. the description of the metric alert that will be included in the alert email.

  • severity (int) – Required. Alert severity {0, 1, 2, 3, 4}

  • enabled (bool) – Required. the flag that indicates whether the metric alert is enabled.

  • scopes (list[str]) – the list of resource id’s that this metric alert is scoped to.

  • evaluation_frequency (timedelta) – Required. how often the metric alert is evaluated represented in ISO 8601 duration format.

  • window_size (timedelta) – Required. the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.

  • criteria (MetricAlertCriteria) – Required. defines the specific alert criteria information.

  • auto_mitigate (bool) – the flag that indicates whether the alert should be auto resolved or not.

  • actions (list[MetricAlertAction]) – the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.

class azure.mgmt.monitor.models.MetricAlertResourcePatch(*, description: str, severity: int, enabled: bool, evaluation_frequency, window_size, criteria, tags=None, scopes=None, auto_mitigate: bool = None, actions=None, **kwargs)[source]

Bases: msrest.serialization.Model

The metric alert resource for patch operations.

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.

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

  • description (str) – Required. the description of the metric alert that will be included in the alert email.

  • severity (int) – Required. Alert severity {0, 1, 2, 3, 4}

  • enabled (bool) – Required. the flag that indicates whether the metric alert is enabled.

  • scopes (list[str]) – the list of resource id’s that this metric alert is scoped to.

  • evaluation_frequency (timedelta) – Required. how often the metric alert is evaluated represented in ISO 8601 duration format.

  • window_size (timedelta) – Required. the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.

  • criteria (MetricAlertCriteria) – Required. defines the specific alert criteria information.

  • auto_mitigate (bool) – the flag that indicates whether the alert should be auto resolved or not.

  • actions (list[MetricAlertAction]) – the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.

Variables

last_updated_time (datetime) – Last time the rule was updated in ISO8601 format.

class azure.mgmt.monitor.models.MetricAlertStatusProperties(*, dimensions=None, status: str = None, timestamp=None, **kwargs)[source]

Bases: msrest.serialization.Model

An alert status properties.

Parameters
  • dimensions (dict[str, str]) –

  • status (str) – status value

  • timestamp (datetime) – UTC time when the status was checked.

class azure.mgmt.monitor.models.MetricAlertStatus(*, name: str = None, id: str = None, type: str = None, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

An alert status.

Parameters
  • name (str) – The status name.

  • id (str) – The alert rule arm id.

  • type (str) – The extended resource type name.

  • properties (MetricAlertStatusProperties) – The alert status properties of the metric alert status.

class azure.mgmt.monitor.models.MetricAlertStatusCollection(*, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

Represents a collection of alert rule resources.

Parameters

value (list[MetricAlertStatus]) – the values for the alert rule resources.

class azure.mgmt.monitor.models.MetricDimension(*, name: str, operator: str, values, **kwargs)[source]

Bases: msrest.serialization.Model

MetricDimension.

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

Parameters
  • name (str) – Required. Name of the dimension.

  • operator (str) – Required. the dimension operator.

  • values (list[str]) – Required. list of dimension values.

class azure.mgmt.monitor.models.MetricCriteria(*, name: str, metric_name: str, operator, time_aggregation, threshold: float, metric_namespace: str = None, dimensions=None, **kwargs)[source]

Bases: msrest.serialization.Model

MetricCriteria.

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

Parameters
  • name (str) – Required. Name of the criteria.

  • metric_name (str) – Required. Name of the metric.

  • metric_namespace (str) – Namespace of the metric.

  • operator (object) – Required. the criteria operator.

  • time_aggregation (object) – Required. the criteria time aggregation types.

  • threshold (float) – Required. the criteria threshold value that activates the alert.

  • dimensions (list[MetricDimension]) – List of dimension conditions.

class azure.mgmt.monitor.models.MetricAlertSingleResourceMultipleMetricCriteria(*, additional_properties=None, all_of=None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.metric_alert_criteria_py3.MetricAlertCriteria

Specifies the metric alert criteria for a single resource that has multiple metric criteria.

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

Parameters
  • additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection

  • odatatype (str) – Required. Constant filled by server.

  • all_of (list[MetricCriteria]) – The list of metric criteria for this ‘all of’ operation.

class azure.mgmt.monitor.models.Source(*, query: str, data_source_id: str, authorized_resources=None, query_type=None, **kwargs)[source]

Bases: msrest.serialization.Model

Specifies the log search query.

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

Parameters
  • query (str) – Required. Log search query.

  • authorized_resources (list[str]) – List of Resource referred into query

  • data_source_id (str) – Required. The resource uri over which log search query is to be run.

  • query_type (str or QueryType) – Set value to ‘ResultCount’. Possible values include: ‘ResultCount’

class azure.mgmt.monitor.models.Schedule(*, frequency_in_minutes: int, time_window_in_minutes: int, **kwargs)[source]

Bases: msrest.serialization.Model

Defines how often to run the search and the time interval.

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

Parameters
  • frequency_in_minutes (int) – Required. frequency (in minutes) at which rule condition should be evaluated.

  • time_window_in_minutes (int) – Required. Time window for which data needs to be fetched for query (should be greater than or equal to frequencyInMinutes).

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

Bases: msrest.serialization.Model

Action.

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

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

Parameters

odatatype (str) – Required. Constant filled by server.

class azure.mgmt.monitor.models.LogSearchRuleResource(*, location: str, source, schedule, action, tags=None, description: str = None, enabled=None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.resource_py3.Resource

The Log Search Rule resource.

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

  • name (str) – Azure resource name

  • type (str) – Azure resource type

  • last_updated_time (datetime) – Last time the rule was updated in IS08601 format.

  • provisioning_state (str or ProvisioningState) – Provisioning state of the scheduledquery rule. Possible values include: ‘Succeeded’, ‘Deploying’, ‘Canceled’, ‘Failed’

Parameters
  • location (str) – Required. Resource location

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

  • description (str) – The description of the Log Search rule.

  • enabled (str or Enabled) – The flag which indicates whether the Log Search rule is enabled. Value should be true or false. Possible values include: ‘true’, ‘false’

  • source (Source) – Required. Data Source against which rule will Query Data

  • schedule (Schedule) – Required. Schedule (Frequnecy, Time Window) for rule.

  • action (Action) – Required. Action needs to be taken on rule execution.

class azure.mgmt.monitor.models.LogSearchRuleResourcePatch(*, tags=None, enabled=None, **kwargs)[source]

Bases: msrest.serialization.Model

The log search rule resource for patch operations.

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

  • enabled (str or Enabled) – The flag which indicates whether the Log Search rule is enabled. Value should be true or false. Possible values include: ‘true’, ‘false’

class azure.mgmt.monitor.models.LogMetricTrigger(*, threshold_operator=None, threshold: float = None, metric_trigger_type=None, metric_column: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

LogMetricTrigger.

Parameters
  • threshold_operator (str or ConditionalOperator) – Evaluation operation for Metric -‘GreaterThan’ or ‘LessThan’ or ‘Equal’. Possible values include: ‘GreaterThan’, ‘LessThan’, ‘Equal’

  • threshold (float) –

  • metric_trigger_type (str or MetricTriggerType) – Metric Trigger Type - ‘Consecutive’ or ‘Total’. Possible values include: ‘Consecutive’, ‘Total’

  • metric_column (str) – Evaluation of metric on a particular column

class azure.mgmt.monitor.models.TriggerCondition(*, threshold_operator, threshold: float, metric_trigger=None, **kwargs)[source]

Bases: msrest.serialization.Model

The condition that results in the Log Search rule.

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

Parameters
  • threshold_operator (str or ConditionalOperator) – Required. Evaluation operation for rule - ‘GreaterThan’ or ‘LessThan. Possible values include: ‘GreaterThan’, ‘LessThan’, ‘Equal’

  • threshold (float) – Required. Result or count threshold based on which rule should be triggered.

  • metric_trigger (LogMetricTrigger) – Trigger condition for metric query rule

class azure.mgmt.monitor.models.AzNsActionGroup(*, action_group=None, email_subject: str = None, custom_webhook_payload: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Azure action group.

Parameters
  • action_group (list[str]) – Azure Action Group reference.

  • email_subject (str) – Custom subject override for all email ids in Azure action group

  • custom_webhook_payload (str) – Custom payload to be sent for all webook URI in Azure action group

class azure.mgmt.monitor.models.AlertingAction(*, severity, azns_action, trigger, throttling_in_min: int = None, **kwargs)[source]

Bases: azure.mgmt.monitor.models.action_py3.Action

Specifiy action need to be taken when rule type is Alert.

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

Parameters
  • odatatype (str) – Required. Constant filled by server.

  • severity (str or AlertSeverity) – Required. Severity of the alert. Possible values include: ‘0’, ‘1’, ‘2’, ‘3’, ‘4’

  • azns_action (AzNsActionGroup) – Required. Azure action group reference.

  • throttling_in_min (int) – time (in minutes) for which Alerts should be throttled or suppressed.

  • trigger (TriggerCondition) – Required. The trigger condition that results in the alert rule being.

class azure.mgmt.monitor.models.AutoscaleSettingResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of AutoscaleSettingResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.monitor.models.IncidentPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Incident object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.monitor.models.AlertRuleResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of AlertRuleResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.monitor.models.LogProfileResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of LogProfileResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.monitor.models.ActionGroupResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ActionGroupResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.monitor.models.ActivityLogAlertResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ActivityLogAlertResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.monitor.models.EventDataPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of EventData object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.monitor.models.LocalizableStringPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of LocalizableString object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.monitor.models.MetricDefinitionPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of MetricDefinition object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.monitor.models.MetricAlertResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of MetricAlertResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.monitor.models.LogSearchRuleResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of LogSearchRuleResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.monitor.models.MetricStatisticType[source]

Bases: str, enum.Enum

An enumeration.

average = 'Average'
max = 'Max'
min = 'Min'
sum = 'Sum'
class azure.mgmt.monitor.models.TimeAggregationType[source]

Bases: str, enum.Enum

An enumeration.

average = 'Average'
count = 'Count'
maximum = 'Maximum'
minimum = 'Minimum'
total = 'Total'
class azure.mgmt.monitor.models.ComparisonOperationType[source]

Bases: str, enum.Enum

An enumeration.

equals = 'Equals'
greater_than = 'GreaterThan'
greater_than_or_equal = 'GreaterThanOrEqual'
less_than = 'LessThan'
less_than_or_equal = 'LessThanOrEqual'
not_equals = 'NotEquals'
class azure.mgmt.monitor.models.ScaleDirection[source]

Bases: str, enum.Enum

An enumeration.

decrease = 'Decrease'
increase = 'Increase'
none = 'None'
class azure.mgmt.monitor.models.ScaleType[source]

Bases: str, enum.Enum

An enumeration.

change_count = 'ChangeCount'
exact_count = 'ExactCount'
percent_change_count = 'PercentChangeCount'
class azure.mgmt.monitor.models.RecurrenceFrequency[source]

Bases: str, enum.Enum

An enumeration.

day = 'Day'
hour = 'Hour'
minute = 'Minute'
month = 'Month'
none = 'None'
second = 'Second'
week = 'Week'
year = 'Year'
class azure.mgmt.monitor.models.ConditionOperator[source]

Bases: str, enum.Enum

An enumeration.

greater_than = 'GreaterThan'
greater_than_or_equal = 'GreaterThanOrEqual'
less_than = 'LessThan'
less_than_or_equal = 'LessThanOrEqual'
class azure.mgmt.monitor.models.TimeAggregationOperator[source]

Bases: str, enum.Enum

An enumeration.

average = 'Average'
last = 'Last'
maximum = 'Maximum'
minimum = 'Minimum'
total = 'Total'
class azure.mgmt.monitor.models.CategoryType[source]

Bases: str, enum.Enum

An enumeration.

logs = 'Logs'
metrics = 'Metrics'
class azure.mgmt.monitor.models.ReceiverStatus[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
not_specified = 'NotSpecified'
class azure.mgmt.monitor.models.EventLevel[source]

Bases: str, enum.Enum

An enumeration.

critical = 'Critical'
error = 'Error'
informational = 'Informational'
verbose = 'Verbose'
warning = 'Warning'
class azure.mgmt.monitor.models.Unit[source]

Bases: str, enum.Enum

An enumeration.

byte_seconds = 'ByteSeconds'
bytes = 'Bytes'
bytes_per_second = 'BytesPerSecond'
count = 'Count'
count_per_second = 'CountPerSecond'
milli_seconds = 'MilliSeconds'
percent = 'Percent'
seconds = 'Seconds'
unspecified = 'Unspecified'
class azure.mgmt.monitor.models.AggregationType[source]

Bases: str, enum.Enum

An enumeration.

average = 'Average'
count = 'Count'
maximum = 'Maximum'
minimum = 'Minimum'
none = 'None'
total = 'Total'
class azure.mgmt.monitor.models.Sensitivity[source]

Bases: str, enum.Enum

An enumeration.

high = 'High'
low = 'Low'
medium = 'Medium'
class azure.mgmt.monitor.models.Enabled[source]

Bases: str, enum.Enum

An enumeration.

false = 'false'
true = 'true'
class azure.mgmt.monitor.models.ProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
deploying = 'Deploying'
failed = 'Failed'
succeeded = 'Succeeded'
class azure.mgmt.monitor.models.QueryType[source]

Bases: str, enum.Enum

An enumeration.

result_count = 'ResultCount'
class azure.mgmt.monitor.models.ConditionalOperator[source]

Bases: str, enum.Enum

An enumeration.

equal = 'Equal'
greater_than = 'GreaterThan'
less_than = 'LessThan'
class azure.mgmt.monitor.models.MetricTriggerType[source]

Bases: str, enum.Enum

An enumeration.

consecutive = 'Consecutive'
total = 'Total'
class azure.mgmt.monitor.models.AlertSeverity[source]

Bases: str, enum.Enum

An enumeration.

four = '4'
one = '1'
three = '3'
two = '2'
zero = '0'
class azure.mgmt.monitor.models.ResultType[source]

Bases: str, enum.Enum

An enumeration.

data = 'Data'
metadata = 'Metadata'