get_recommendations

Creates, updates, deletes, gets or lists a get_recommendations resource.

Overview

Name	get_recommendations
Type	Resource
Id	azure.security_insight.get_recommendations

Fields

The following fields are returned by SELECT queries:

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.
additionalProperties	object	Collection of additional properties for the recommendation.
creationTimeUtc	string (date-time)	The time stamp (UTC) when the recommendation was created. Required.
description	string	Description of the recommendation. Required.
etag	string	Etag of the azure resource.
lastEvaluatedTimeUtc	string (date-time)	The time stamp (UTC) when the recommendation was last evaluated. Required.
lastModifiedTimeUtc	string (date-time)	The time stamp (UTC) when the recommendation was last modified. Required.
recommendationTypeId	string	Id of the recommendation type. Required.
resourceId	string	Id of the resource this recommendation refers to.
state	string	State of the recommendation. Required. Known values are: "Active", "InProgress", "Dismissed", "CompletedByUser", and "CompletedBySystem". (Active, InProgress, Dismissed, CompletedByUser, CompletedBySystem)
suggestions	array	List of suggestions to take for this recommendation. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	Title of the recommendation. Required.
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
list	select	resource_group_name, workspace_name, subscription_id		Gets a list of all recommendations.

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.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

list

Gets a list of all recommendations.

SELECT
id,
name,
additionalProperties,
creationTimeUtc,
description,
etag,
lastEvaluatedTimeUtc,
lastModifiedTimeUtc,
recommendationTypeId,
resourceId,
state,
suggestions,
systemData,
title,
type
FROM azure.security_insight.get_recommendations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;