iot_security_solutions_analytics_aggregated_alerts

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

Overview

Name	iot_security_solutions_analytics_aggregated_alerts
Type	Resource
Id	azure.security.iot_security_solutions_analytics_aggregated_alerts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	IoT Security solution aggregated alert details.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	IoT Security solution aggregated alert details.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags
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	subscriptionId, resourceGroupName, solutionName, aggregatedAlertName	api-version	Use this method to get a single the aggregated alert of yours IoT Security solution. This aggregation is performed by alert name.
list	select	subscriptionId, resourceGroupName, solutionName	api-version, $top	Use this method to get the aggregated alert list of yours IoT Security solution.
dismiss	exec	subscriptionId, resourceGroupName, solutionName, aggregatedAlertName	api-version	Use this method to dismiss an aggregated IoT Security Solution 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
aggregatedAlertName	string	Identifier of the aggregated alert.
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
solutionName	string	The name of the IoT Security solution.
subscriptionId	string	Azure subscription ID
$top	integer (int32)	Number of results to retrieve.
api-version	string	API version for the operation

SELECT examples

get

Use this method to get a single the aggregated alert of yours IoT Security solution. This aggregation is performed by alert name.

SELECT
id,
name,
properties,
systemData,
tags,
type
FROM azure.security.iot_security_solutions_analytics_aggregated_alerts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND solutionName = '{{ solutionName }}' -- required
AND aggregatedAlertName = '{{ aggregatedAlertName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Use this method to get the aggregated alert list of yours IoT Security solution.

SELECT
id,
name,
properties,
systemData,
tags,
type
FROM azure.security.iot_security_solutions_analytics_aggregated_alerts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND solutionName = '{{ solutionName }}' -- required
AND api-version = '{{ api-version }}'
AND $top = '{{ $top }}'
;

Lifecycle Methods

dismiss

Use this method to dismiss an aggregated IoT Security Solution Alert.

EXEC azure.security.iot_security_solutions_analytics_aggregated_alerts.dismiss 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@solutionName='{{ solutionName }}' --required, 
@aggregatedAlertName='{{ aggregatedAlertName }}' --required, 
@api-version='{{ api-version }}'
;