alerts

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

Overview

Name	alerts
Type	Resource
Id	azure_extras.storsimple_8000_series.alerts

Fields

The following fields are returned by SELECT queries:

list_by_manager

The collection of alerts.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The name of the object.
kind	string	The Kind of the object. Currently only Series8000 is supported
properties	object	The properties of the alert.
type	string	The hierarchical type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_manager	select	subscriptionId, resourceGroupName, managerName	$filter	Retrieves all the alerts in a manager.
clear	exec	subscriptionId, resourceGroupName, managerName, alerts		Clear the alerts.
send_test_email	exec	deviceName, subscriptionId, resourceGroupName, managerName, emailList		Sends a test alert email.

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
deviceName	string	The device name
managerName	string	The manager name
resourceGroupName	string	The resource group name
subscriptionId	string	The subscription id
$filter	string	OData Filter options

SELECT examples

list_by_manager

Retrieves all the alerts in a manager.

SELECT
id,
name,
kind,
properties,
type
FROM azure_extras.storsimple_8000_series.alerts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

clear

Clear the alerts.

EXEC azure_extras.storsimple_8000_series.alerts.clear 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required 
@@json=
'{
"resolutionMessage": "{{ resolutionMessage }}", 
"alerts": "{{ alerts }}"
}'
;

send_test_email

Sends a test alert email.

EXEC azure_extras.storsimple_8000_series.alerts.send_test_email 
@deviceName='{{ deviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required 
@@json=
'{
"emailList": "{{ emailList }}"
}'
;