alert_rules

Creates, updates, deletes, gets or lists an alert_rules resource.

Overview

Name	alert_rules
Type	Resource
Id	azure.security_insight.alert_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
etag	string	Etag of the azure resource.
kind	string	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. Required. Known values are: "Scheduled", "MicrosoftSecurityIncidentCreation", "Fusion", "MLBehaviorAnalytics", "ThreatIntelligence", and "NRT".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
etag	string	Etag of the azure resource.
kind	string	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. Required. Known values are: "Scheduled", "MicrosoftSecurityIncidentCreation", "Fusion", "MLBehaviorAnalytics", "ThreatIntelligence", and "NRT".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, rule_id, subscription_id		Gets the alert rule.
list	select	resource_group_name, workspace_name, subscription_id		Gets all alert rules.
create_or_update	insert	resource_group_name, workspace_name, rule_id, subscription_id, kind		Creates or updates the alert rule.
create_or_update	replace	resource_group_name, workspace_name, rule_id, subscription_id, kind		Creates or updates the alert rule.
delete	delete	resource_group_name, workspace_name, rule_id, subscription_id		Delete the alert rule.

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.

SELECT examples

get

Gets the alert rule.

SELECT
id,
name,
etag,
kind,
systemData,
type
FROM azure.security_insight.alert_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND rule_id = '{{ rule_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all alert rules.

SELECT
id,
name,
etag,
kind,
systemData,
type
FROM azure.security_insight.alert_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the alert rule.

INSERT INTO azure.security_insight.alert_rules (
kind,
etag,
resource_group_name,
workspace_name,
rule_id,
subscription_id
)
SELECT 
'{{ kind }}' /* required */,
'{{ etag }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ rule_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
kind,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: alert_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the alert_rules resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the alert_rules resource.
  - name: rule_id
    value: "{{ rule_id }}"
    description: Required parameter for the alert_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the alert_rules resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      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. Required. Known values are: "Scheduled", "MicrosoftSecurityIncidentCreation", "Fusion", "MLBehaviorAnalytics", "ThreatIntelligence", and "NRT".
  - name: etag
    value: "{{ etag }}"
    description: |
      Etag of the azure resource.

REPLACE examples

create_or_update

Creates or updates the alert rule.

REPLACE azure.security_insight.alert_rules
SET 
kind = '{{ kind }}',
etag = '{{ etag }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND rule_id = '{{ rule_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
etag,
kind,
systemData,
type;

DELETE examples

delete

Delete the alert rule.

DELETE FROM azure.security_insight.alert_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND rule_id = '{{ rule_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;