entity_queries

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

Overview

Name	entity_queries
Type	Resource
Id	azure.security_insight.entity_queries

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.
etag	string	Etag of the azure resource.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. Required. Known values are: "Expansion", "Insight", and "Activity".
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.
etag	string	Etag of the azure resource.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. Required. Known values are: "Expansion", "Insight", and "Activity".
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_id, subscription_id		Gets an entity query.
list	select	resource_group_name, workspace_name, subscription_id	kind	Gets all entity queries.
create_or_update	insert	resource_group_name, workspace_name, entity_query_id, subscription_id, kind		Creates or updates the entity query.
create_or_update	replace	resource_group_name, workspace_name, entity_query_id, subscription_id, kind		Creates or updates the entity query.
delete	delete	resource_group_name, workspace_name, entity_query_id, subscription_id		Delete the entity query.

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_id	string	entity query 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 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,
etag,
kind,
systemData,
type
FROM azure.security_insight.entity_queries
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND entity_query_id = '{{ entity_query_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all entity queries.

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

INSERT examples

create_or_update

Creates or updates the entity query.

INSERT INTO azure.security_insight.entity_queries (
etag,
kind,
resource_group_name,
workspace_name,
entity_query_id,
subscription_id
)
SELECT 
'{{ etag }}',
'{{ kind }}' /* required */,
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ entity_query_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
kind,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: entity_queries
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the entity_queries resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the entity_queries resource.
  - name: entity_query_id
    value: "{{ entity_query_id }}"
    description: Required parameter for the entity_queries resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the entity_queries resource.
  - name: etag
    value: "{{ etag }}"
    description: |
      Etag of the azure resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      the entity query kind. Required. "Activity"

REPLACE examples

create_or_update

Creates or updates the entity query.

REPLACE azure.security_insight.entity_queries
SET 
etag = '{{ etag }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND entity_query_id = '{{ entity_query_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
etag,
kind,
systemData,
type;

DELETE examples

delete

Delete the entity query.

DELETE FROM azure.security_insight.entity_queries
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND entity_query_id = '{{ entity_query_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;