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

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.
alertType	string	Alert type.
appearedAtDateTime	string (date-time)	UTC time when the alert appeared.
detailedInformation	object	Alert details.
errorDetails	object	Error details of the alert.
recommendation	string	Alert recommendation.
severity	string	Severity of the alert. Known values are: "Informational", "Warning", and "Critical". (Informational, Warning, Critical)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	Alert title.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_data_box_edge_device

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.
alertType	string	Alert type.
appearedAtDateTime	string (date-time)	UTC time when the alert appeared.
detailedInformation	object	Alert details.
errorDetails	object	Error details of the alert.
recommendation	string	Alert recommendation.
severity	string	Severity of the alert. Known values are: "Informational", "Warning", and "Critical". (Informational, Warning, Critical)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	Alert title.
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	device_name, name, resource_group_name, subscription_id		Gets an alert by name. Gets an alert by name.
list_by_data_box_edge_device	select	device_name, resource_group_name, subscription_id		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
device_name	string	The device name. Required.
name	string	The alert name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets an alert by name. Gets an alert by name.

SELECT
id,
name,
alertType,
appearedAtDateTime,
detailedInformation,
errorDetails,
recommendation,
severity,
systemData,
title,
type
FROM azure.data_box_edge.alerts
WHERE device_name = '{{ device_name }}' -- required
AND name = '{{ name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_data_box_edge_device

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

SELECT
id,
name,
alertType,
appearedAtDateTime,
detailedInformation,
errorDetails,
recommendation,
severity,
systemData,
title,
type
FROM azure.data_box_edge.alerts
WHERE device_name = '{{ device_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;