ScheduledQueryRuleResourcePatch Class

The scheduled query rule resource for patch operations.

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

Inheritance
azure.mgmt.monitor._serialization.Model
ScheduledQueryRuleResourcePatch

Constructor

ScheduledQueryRuleResourcePatch(*, tags: Dict[str, str] | None = None, description: str | None = None, display_name: str | None = None, severity: float | _models.AlertSeverity | None = None, enabled: bool | None = None, scopes: List[str] | None = None, evaluation_frequency: timedelta | None = None, window_size: timedelta | None = None, override_query_time_range: timedelta | None = None, target_resource_types: List[str] | None = None, criteria: _models.ScheduledQueryRuleCriteria | None = None, mute_actions_duration: timedelta | None = None, actions: List[_models.Action] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
tags

Resource tags.

description
str

The description of the scheduled query rule.

display_name
str

The display name of the alert rule.

severity

Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Known values are: 0, 1, 2, 3, and 4.

enabled

The flag which indicates whether this scheduled query rule is enabled. Value should be true or false.

scopes

The list of resource id's that this scheduled query rule is scoped to.

evaluation_frequency

How often the scheduled query rule is evaluated represented in ISO 8601 duration format.

window_size

The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size).

override_query_time_range

If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods).

target_resource_types

List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria.

criteria

The rule criteria that defines the conditions of the scheduled query rule.

mute_actions_duration

Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired.

actions

Variables

Name Description
tags

Resource tags.

created_with_api_version
str

The api-version used when creating this alert rule.

is_legacy_log_analytics_rule

True if alert rule is legacy Log Analytic rule.

description
str

The description of the scheduled query rule.

display_name
str

The display name of the alert rule.

severity

Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Known values are: 0, 1, 2, 3, and 4.

enabled

The flag which indicates whether this scheduled query rule is enabled. Value should be true or false.

scopes

The list of resource id's that this scheduled query rule is scoped to.

evaluation_frequency

How often the scheduled query rule is evaluated represented in ISO 8601 duration format.

window_size

The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size).

override_query_time_range

If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods).

target_resource_types

List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria.

criteria

The rule criteria that defines the conditions of the scheduled query rule.

mute_actions_duration

Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired.

actions