alerts

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

Overview

Name	alerts
Type	Resource
Id	azure_stack.infrastructure_insights_admin.alerts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The Azure Region where the resource lives
properties	object	Contains information related to alerts.
tags	object	Resource tags.

list

Name	Datatype	Description
location	string	The Azure Region where the resource lives
properties	object	Contains information related to alerts.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, location, alertName		Returns the requested an alert.
list	select	subscriptionId, resourceGroupName, location	$filter	Returns the list of all alerts in a given region.
close	exec	subscriptionId, resourceGroupName, location, alertName, user		Closes the given alert.
repair	exec	subscriptionId, resourceGroupName, location, alertName		Repairs an alert.

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
alertName	string	Name of the alert.
location	string	Name of the region
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
user	string	The username used to perform the operation.
$filter	string	OData filter parameter.

SELECT examples

get

Returns the requested an alert.

SELECT
location,
properties,
tags
FROM azure_stack.infrastructure_insights_admin.alerts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND location = '{{ location }}' -- required
AND alertName = '{{ alertName }}' -- required
;

list

Returns the list of all alerts in a given region.

SELECT
location,
properties,
tags
FROM azure_stack.infrastructure_insights_admin.alerts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND location = '{{ location }}' -- required
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

close

Closes the given alert.

EXEC azure_stack.infrastructure_insights_admin.alerts.close 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@alertName='{{ alertName }}' --required, 
@user='{{ user }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"tags": "{{ tags }}", 
"location": "{{ location }}"
}'
;

repair

Repairs an alert.

EXEC azure_stack.infrastructure_insights_admin.alerts.repair 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@alertName='{{ alertName }}' --required
;