alert_rule
Creates, updates, deletes, gets or lists an alert_rule resource.
Overview
| Name | alert_rule |
| Type | Resource |
| Id | azure.security_insight.alert_rule |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
trigger_rule_run | exec | resource_group_name, workspace_name, rule_id, subscription_id, properties | triggers analytics rule run. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
rule_id | string | Alert rule ID. Required. |
subscription_id | string | |
workspace_name | string | The name of the monitor workspace. Required. |
Lifecycle Methods
- trigger_rule_run
triggers analytics rule run.
EXEC azure.security_insight.alert_rule.trigger_rule_run
@resource_group_name='{{ resource_group_name }}' --required,
@workspace_name='{{ workspace_name }}' --required,
@rule_id='{{ rule_id }}' --required,
@subscription_id='{{ subscription_id }}' --required
@@json=
'{
"properties": "{{ properties }}"
}'
;