entity_query_templates

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

Overview

Name	entity_query_templates
Type	Resource
Id	azure.security_insight.entity_query_templates

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.
kind	string	The kind of the entity query template. Required. Known values are: "Activity", "Insight", "SecurityAlert", "Bookmark", "Expansion", "GuidedInsight", and "Anomaly".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
kind	string	The kind of the entity query template. Required. Known values are: "Activity", "Insight", "SecurityAlert", "Bookmark", "Expansion", "GuidedInsight", and "Anomaly".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	resource_group_name, workspace_name, entity_query_template_id, subscription_id		Gets an entity query.
list	select	resource_group_name, workspace_name, subscription_id	kind	Gets all entity query templates.

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
entity_query_template_id	string	entity query template ID. Required.
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.
kind	string	The entity template query kind we want to fetch. Known values are: "Activity", "Insight", "SecurityAlert", "Bookmark", "Expansion", "GuidedInsight", and "Anomaly". Default value is None.

SELECT examples

get

Gets an entity query.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.security_insight.entity_query_templates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND entity_query_template_id = '{{ entity_query_template_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all entity query templates.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.security_insight.entity_query_templates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND kind = '{{ kind }}'
;