azure.mgmt.monitor.models module

class azure.mgmt.monitor.models.Resource(location, tags=None)[source]

Bases: msrest.serialization.Model

An azure resource object.

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

Variables:
  • id (str) – Azure resource Id
  • name (str) – Azure resource name
  • type (str) – Azure resource type
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
class azure.mgmt.monitor.models.ScaleCapacity(minimum, maximum, default)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • minimum (str) – the minimum number of instances for the resource.
  • maximum (str) – 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) – 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, metric_resource_uri, time_grain, statistic, time_window, time_aggregation, operator, threshold)[source]

Bases: msrest.serialization.Model

The trigger that results in a scaling action.

Parameters:
  • metric_name (str) – the name of the metric that defines what the rule monitors.
  • metric_resource_uri (str) – the resource identifier of the resource the rule monitors.
  • time_grain (timedelta) – 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) – the metric statistic type. How the metrics from multiple instances are combined. Possible values include: ‘Average’, ‘Min’, ‘Max’, ‘Sum’
  • time_window (timedelta) – 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) – 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) – the operator that is used to compare the metric data and the threshold. Possible values include: ‘Equals’, ‘NotEquals’, ‘GreaterThan’, ‘GreaterThanOrEqual’, ‘LessThan’, ‘LessThanOrEqual’
  • threshold (float) – the threshold of the metric that triggers the scale action.
class azure.mgmt.monitor.models.ScaleAction(direction, type, cooldown, value='1')[source]

Bases: msrest.serialization.Model

The parameters for the scaling action.

Parameters:
  • direction (str or ScaleDirection) – the scale direction. Whether the scaling action increases or decreases the number of instances. Possible values include: ‘None’, ‘Increase’, ‘Decrease’
  • type (str or ScaleType) – 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) – 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)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • metric_trigger (MetricTrigger) – the trigger that results in a scaling action.
  • scale_action (ScaleAction) – the parameters for the scaling action.
class azure.mgmt.monitor.models.TimeWindow(start, end, time_zone=None)[source]

Bases: msrest.serialization.Model

A specific date-time for the profile.

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) – the start time for the profile in ISO 8601 format.
  • end (datetime) – the end time for the profile in ISO 8601 format.
class azure.mgmt.monitor.models.RecurrentSchedule(time_zone, days, hours, minutes)[source]

Bases: msrest.serialization.Model

The scheduling constraints for when the profile begins.

Parameters:
  • time_zone (str) – 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 of str) – the collection of days that the profile takes effect on. Possible values are Sunday through Saturday.
  • hours (list of int) – 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 of int) – A collection of minutes at which the profile takes effect at.
class azure.mgmt.monitor.models.Recurrence(frequency, schedule)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • frequency (str or RecurrenceFrequency) – 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) – the scheduling constraints for when the profile begins.
class azure.mgmt.monitor.models.AutoscaleProfile(name, capacity, rules, fixed_date=None, recurrence=None)[source]

Bases: msrest.serialization.Model

Autoscale profile.

Parameters:
  • name (str) – the name of the profile.
  • capacity (ScaleCapacity) – the number of instances that can be used during this profile.
  • rules (list of ScaleRule) – 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=None, send_to_subscription_co_administrators=None, custom_emails=None)[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 of 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=None, properties=None)[source]

Bases: msrest.serialization.Model

Webhook notification of an autoscale event.

Parameters:
  • service_uri (str) – the service address to receive the notification.
  • properties (dict) – a property bag of settings. This value can be empty.
class azure.mgmt.monitor.models.AutoscaleNotification(email=None, webhooks=None)[source]

Bases: msrest.serialization.Model

Autoscale notification.

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

Variables:

operation (str) – 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, profiles, tags=None, notifications=None, enabled=True, autoscale_setting_resource_name=None, target_resource_uri=None)[source]

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

The autoscale 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:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • profiles (list of AutoscaleProfile) – 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 of 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.ErrorResponse(code=None, message=None)[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.RuleDataSource(resource_uri=None)[source]

Bases: msrest.serialization.Model

The resource from which the rule collects its data.

Parameters:
  • resource_uri (str) – the resource identifier of the resource the rule monitors.
  • odatatype (str) – Polymorphic Discriminator
class azure.mgmt.monitor.models.RuleCondition(data_source=None)[source]

Bases: msrest.serialization.Model

The condition that results in the alert rule being activated.

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) – Polymorphic Discriminator
class azure.mgmt.monitor.models.RuleMetricDataSource(resource_uri=None, metric_name=None)[source]

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

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

Parameters:
  • resource_uri (str) – the resource identifier of the resource the rule monitors.
  • odatatype (str) – Polymorphic Discriminator
  • metric_name (str) – the name of the metric that defines what the rule monitors.
class azure.mgmt.monitor.models.RuleManagementEventClaimsDataSource(email_address=None)[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=None, event_name=None, event_source=None, level=None, operation_name=None, resource_group_name=None, resource_provider_name=None, status=None, sub_status=None, claims=None)[source]

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

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

Parameters:
  • resource_uri (str) – the resource identifier of the resource the rule monitors.
  • odatatype (str) – Polymorphic Discriminator
  • 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, data_source=None, window_size=None, time_aggregation=None)[source]

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

A rule condition based on a metric crossing a threshold.

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) – Polymorphic Discriminator
  • operator (str or ConditionOperator) – the operator used to compare the data and the threshold. 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.
  • 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, data_source=None, window_size=None)[source]

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

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

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) – Polymorphic Discriminator
  • 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) – the number of locations that must fail to activate the alert.
class azure.mgmt.monitor.models.ManagementEventAggregationCondition(operator=None, threshold=None, window_size=None)[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)[source]

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

A management event rule condition.

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) – Polymorphic Discriminator
  • 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[source]

Bases: msrest.serialization.Model

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

Parameters:odatatype (str) – Polymorphic Discriminator
class azure.mgmt.monitor.models.RuleEmailAction(send_to_service_owners=None, custom_emails=None)[source]

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

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

Parameters:
  • odatatype (str) – Polymorphic Discriminator
  • send_to_service_owners (bool) – Whether the administrators (service and co-adiminstrators) of the service should be notified when the alert is activated.
  • custom_emails (list of str) – the list of administrator’s custom email addresses notifiy of the activation of the alert.
class azure.mgmt.monitor.models.RuleWebhookAction(service_uri=None, properties=None)[source]

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

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

Parameters:
  • odatatype (str) – Polymorphic Discriminator
  • service_uri (str) – the service uri to Post the notitication when the alert activates or resolves.
  • properties (dict) – 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, alert_rule_resource_name, is_enabled, condition, tags=None, description=None, actions=None)[source]

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

The alert rule 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
  • last_updated_time (datetime) – Last time the rule was updated in ISO8601 format.
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • alert_rule_resource_name (str) – 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) – the flag that indicates whether the alert rule is enabled.
  • condition (RuleCondition) – the condition that results in the alert rule being activated.
  • actions (list of 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.Incident[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.ActivityLogAlertLeafCondition(field, equals)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • field (str) – 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) – 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)[source]

Bases: msrest.serialization.Model

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

Parameters:all_of (list of ActivityLogAlertLeafCondition) – The list of activity log alert conditions.
class azure.mgmt.monitor.models.ActivityLogAlertActionGroup(action_group_id, webhook_properties=None)[source]

Bases: msrest.serialization.Model

A pointer to an Azure Action Group.

Parameters:
  • action_group_id (str) – The resourceId of the action group. This cannot be null or empty.
  • webhook_properties (dict) – 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)[source]

Bases: msrest.serialization.Model

A list of activity log alert actions.

Parameters:action_groups (list of ActivityLogAlertActionGroup) – The list of activity log alerts.
class azure.mgmt.monitor.models.ActivityLogAlertResource(location, scopes, condition, actions, tags=None, enabled=True, description=None)[source]

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

An activity log alert 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:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • scopes (list of str) – 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) – The conditon that will cause this alert to activate.
  • actions (ActivityLogAlertActionList) – The actions that will activate when the condition is met.
  • description (str) – A description of this activity log alert.
class azure.mgmt.monitor.models.ActivityLogAlertResourcePatch(location, tags=None, enabled=True)[source]

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

An activity log alert resource for patch operations.

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:
  • location (str) – Resource location
  • tags (dict) – 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.RetentionPolicy(enabled, days)[source]

Bases: msrest.serialization.Model

Specifies the retention policy for the log.

Parameters:
  • enabled (bool) – a value indicating whether the retention policy is enabled.
  • days (int) – 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, locations, categories, retention_policy, tags=None, storage_account_id=None, service_bus_rule_id=None)[source]

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

The log profile 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:
  • location (str) – Resource location
  • tags (dict) – 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 of str) – 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 of str) – 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) – the retention policy for the events in the log.
class azure.mgmt.monitor.models.MetricSettings(time_grain, enabled, retention_policy=None)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • time_grain (timedelta) – the timegrain of the metric in ISO8601 format.
  • enabled (bool) – a value indicating whether this timegrain is enabled.
  • retention_policy (RetentionPolicy) – the retention policy for this timegrain.
class azure.mgmt.monitor.models.LogSettings(enabled, category=None, retention_policy=None)[source]

Bases: msrest.serialization.Model

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

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) – a value indicating whether this log is enabled.
  • retention_policy (RetentionPolicy) – the retention policy for this log.
class azure.mgmt.monitor.models.ServiceDiagnosticSettingsResource(location, tags=None, storage_account_id=None, service_bus_rule_id=None, event_hub_authorization_rule_id=None, metrics=None, logs=None, workspace_id=None)[source]

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

Description of a service diagnostic setting.

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:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • storage_account_id (str) – The resource ID of the storage account to which you would like to send Diagnostic Logs.
  • 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 Diagnostic Logs. The rule ID is of the format: ‘{service bus resource ID}/authorizationrules/{key name}’.
  • event_hub_authorization_rule_id (str) – The resource Id for the event hub authorization rule.
  • metrics (list of MetricSettings) – the list of metric settings.
  • logs (list of 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.AutoscaleSettingResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of AutoscaleSettingResource object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of AlertRuleResource object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of Incident object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of ActivityLogAlertResource object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of LogProfileResource object

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

Bases: enum.Enum

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

Bases: enum.Enum

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

Bases: enum.Enum

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: enum.Enum

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

Bases: enum.Enum

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

Bases: enum.Enum

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

Bases: enum.Enum

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

Bases: enum.Enum

average = 'Average'
last = 'Last'
maximum = 'Maximum'
minimum = 'Minimum'
total = 'Total'