iot_security_solutions_analytics_recommendation

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

Overview

Name	iot_security_solutions_analytics_recommendation
Type	Resource
Id	azure.security.iot_security_solutions_analytics_recommendation

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.
description	string	Description of the suspected vulnerability and meaning.
detectedBy	string	Name of the organization that made the recommendation.
healthyDevices	integer	Number of healthy devices within the IoT Security solution.
logAnalyticsQuery	string	Log analytics query for getting the list of affected devices/alerts.
recommendationDisplayName	string	Display name of the recommendation type.
recommendationName	string	Name of the recommendation.
recommendationTypeId	string	Recommendation-type GUID.
remediationSteps	string	Recommended steps for remediation.
reportedSeverity	string	Assessed recommendation severity. Known values are: "Informational", "Low", "Medium", and "High". (Informational, Low, Medium, High)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
unhealthyDeviceCount	integer	Number of unhealthy devices within the IoT Security solution.

list

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.
description	string	Description of the suspected vulnerability and meaning.
detectedBy	string	Name of the organization that made the recommendation.
healthyDevices	integer	Number of healthy devices within the IoT Security solution.
logAnalyticsQuery	string	Log analytics query for getting the list of affected devices/alerts.
recommendationDisplayName	string	Display name of the recommendation type.
recommendationName	string	Name of the recommendation.
recommendationTypeId	string	Recommendation-type GUID.
remediationSteps	string	Recommended steps for remediation.
reportedSeverity	string	Assessed recommendation severity. Known values are: "Informational", "Low", "Medium", and "High". (Informational, Low, Medium, High)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
unhealthyDeviceCount	integer	Number of unhealthy devices within the 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, aggregated_recommendation_name, subscription_id		Use this method to get the aggregated security analytics recommendation of yours IoT Security solution. This aggregation is performed by recommendation name.
list	select	resource_group_name, solution_name, subscription_id	$top	Use this method to get the list of aggregated security analytics recommendations of yours IoT Security solution.

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
aggregated_recommendation_name	string	Name of the recommendation aggregated for this query. Required.
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
$top	integer	Number of results to retrieve. Default value is None.

SELECT examples

get

Use this method to get the aggregated security analytics recommendation of yours IoT Security solution. This aggregation is performed by recommendation name.

SELECT
id,
name,
description,
detectedBy,
healthyDevices,
logAnalyticsQuery,
recommendationDisplayName,
recommendationName,
recommendationTypeId,
remediationSteps,
reportedSeverity,
systemData,
tags,
type,
unhealthyDeviceCount
FROM azure.security.iot_security_solutions_analytics_recommendation
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND solution_name = '{{ solution_name }}' -- required
AND aggregated_recommendation_name = '{{ aggregated_recommendation_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Use this method to get the list of aggregated security analytics recommendations of yours IoT Security solution.

SELECT
id,
name,
description,
detectedBy,
healthyDevices,
logAnalyticsQuery,
recommendationDisplayName,
recommendationName,
recommendationTypeId,
remediationSteps,
reportedSeverity,
systemData,
tags,
type,
unhealthyDeviceCount
FROM azure.security.iot_security_solutions_analytics_recommendation
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND solution_name = '{{ solution_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;