activity_log_alerts

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

Overview

Name	activity_log_alerts
Type	Resource
Id	azure.monitor.activity_log_alerts

Fields

The following fields are returned by SELECT queries:

get

The request succeeded.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	The Activity Log Alert rule properties of the resource.
tags	object	Resource tags
type	string	Azure resource type

list_by_resource_group

The request succeeded.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	The Activity Log Alert rule properties of the resource.
tags	object	Resource tags
type	string	Azure resource type

list_by_subscription_id

The request succeeded.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	The Activity Log Alert rule properties of the resource.
tags	object	Resource tags
type	string	Azure resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, activityLogAlertName		Get an Activity Log Alert rule.
list_by_resource_group	select	subscriptionId, resourceGroupName		Get a list of all Activity Log Alert rules in a resource group.
list_by_subscription_id	select	subscriptionId		Get a list of all Activity Log Alert rules in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, activityLogAlertName		Create a new Activity Log Alert rule or update an existing one.
update	update	subscriptionId, resourceGroupName, activityLogAlertName		Updates 'tags' and 'enabled' fields in an existing Alert rule. This method is used to update the Alert rule tags, and to enable or disable the Alert rule. To update other fields use CreateOrUpdate operation.
delete	delete	subscriptionId, resourceGroupName, activityLogAlertName		Delete an Activity Log 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
activityLogAlertName	string	The name of the Activity Log Alert rule.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get an Activity Log Alert rule.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.activity_log_alerts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND activityLogAlertName = '{{ activityLogAlertName }}' -- required
;

list_by_resource_group

Get a list of all Activity Log Alert rules in a resource group.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.activity_log_alerts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription_id

Get a list of all Activity Log Alert rules in a subscription.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.activity_log_alerts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a new Activity Log Alert rule or update an existing one.

INSERT INTO azure.monitor.activity_log_alerts (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
activityLogAlertName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ activityLogAlertName }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: activity_log_alerts
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the activity_log_alerts resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the activity_log_alerts resource.
    - name: activityLogAlertName
      value: string
      description: Required parameter for the activity_log_alerts resource.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags
    - name: properties
      value: object
      description: |
        The Activity Log Alert rule properties of the resource.

UPDATE examples

update

Updates 'tags' and 'enabled' fields in an existing Alert rule. This method is used to update the Alert rule tags, and to enable or disable the Alert rule. To update other fields use CreateOrUpdate operation.

UPDATE azure.monitor.activity_log_alerts
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND activityLogAlertName = '{{ activityLogAlertName }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete an Activity Log Alert rule.

DELETE FROM azure.monitor.activity_log_alerts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND activityLogAlertName = '{{ activityLogAlertName }}' --required
;