LogSearchRuleResource Class

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.

Inheritance
azure.mgmt.monitor.v2018_04_16.models._models_py3.Resource
LogSearchRuleResource

Constructor

LogSearchRuleResource(*, location: str, source: _models.Source, action: _models.Action, tags: Dict[str, str] | None = None, description: str | None = None, display_name: str | None = None, auto_mitigate: bool = False, enabled: str | _models.Enabled | None = None, schedule: _models.Schedule | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
location
str

Resource location. Required.

tags

Resource tags.

description
str

The description of the Log Search rule.

display_name
str

The display name of the alert rule.

auto_mitigate

The flag that indicates whether the alert should be automatically resolved or not. The default is false.

enabled

The flag which indicates whether the Log Search rule is enabled. Value should be true or false. Known values are: "true" and "false".

source

Data Source against which rule will Query Data. Required.

schedule

Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction.

action

Action needs to be taken on rule execution. Required.

Variables

Name Description
id
str

Azure resource Id.

name
str

Azure resource name.

type
str

Azure resource type.

location
str

Resource location. Required.

tags

Resource tags.

kind
str

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

etag
str

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

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 Log Search rule.

display_name
str

The display name of the alert rule.

auto_mitigate

The flag that indicates whether the alert should be automatically resolved or not. The default is false.

enabled

The flag which indicates whether the Log Search rule is enabled. Value should be true or false. Known values are: "true" and "false".

last_updated_time

Last time the rule was updated in IS08601 format.

provisioning_state

Provisioning state of the scheduled query rule. Known values are: "Succeeded", "Deploying", "Canceled", and "Failed".

source

Data Source against which rule will Query Data. Required.

schedule

Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction.

action

Action needs to be taken on rule execution. Required.