alerts

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

Overview

Name	alerts
Type	Resource
Id	azure.data_box_edge.alerts

Fields

The following fields are returned by SELECT queries:

get

The alert details.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	Properties of alert.
systemData	object	Metadata pertaining to creation and last modification of Alert
type	string	The hierarchical type of the object.

list_by_data_box_edge_device

The collection of alerts.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	Properties of alert.
systemData	object	Metadata pertaining to creation and last modification of 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
get	select	deviceName, name, subscriptionId, resourceGroupName
list_by_data_box_edge_device	select	deviceName, subscriptionId, resourceGroupName		Gets all the alerts for a Data Box Edge/Data Box Gateway device.

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.
name	string	The alert name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription ID.

SELECT examples

get

The alert details.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.alerts
WHERE deviceName = '{{ deviceName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_data_box_edge_device

Gets all the alerts for a Data Box Edge/Data Box Gateway device.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.alerts
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;