iot_security_solution_analytics

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

Overview

Name	iot_security_solution_analytics
Type	Resource
Id	azure.security.iot_security_solution_analytics

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.
devicesMetrics	array	List of device metrics by the aggregation date.
metrics	object	Security analytics of your IoT Security solution.
mostPrevalentDeviceAlerts	array	List of the 3 most prevalent device alerts.
mostPrevalentDeviceRecommendations	array	List of the 3 most prevalent device recommendations.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topAlertedDevices	array	List of the 3 devices with the most alerts.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
unhealthyDeviceCount	integer	Number of unhealthy devices within your IoT Security solution.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, solution_name, subscription_id		Use this method to get IoT Security Analytics metrics.
list_raw	exec	resource_group_name, solution_name, subscription_id		Use this method to get IoT security Analytics metrics in an array.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
solution_name	string	The name of the IoT Security solution. Required.
subscription_id	string

SELECT examples

get

Use this method to get IoT Security Analytics metrics.

SELECT
id,
name,
devicesMetrics,
metrics,
mostPrevalentDeviceAlerts,
mostPrevalentDeviceRecommendations,
systemData,
topAlertedDevices,
type,
unhealthyDeviceCount
FROM azure.security.iot_security_solution_analytics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND solution_name = '{{ solution_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

list_raw

Use this method to get IoT security Analytics metrics in an array.

EXEC azure.security.iot_security_solution_analytics.list_raw 
@resource_group_name='{{ resource_group_name }}' --required, 
@solution_name='{{ solution_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;