entity_relations

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

Overview

Name	entity_relations
Type	Resource
Id	azure.security_insight.entity_relations

Fields

The following fields are returned by SELECT queries:

get_relation

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.
relatedResourceId	string	The resource ID of the related resource. Required.
relatedResourceKind	string	The resource kind of the related resource.
relatedResourceName	string	The name of the related resource.
relatedResourceType	string	The resource type of the related resource.
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_relation	select	resource_group_name, workspace_name, entity_id, relation_name, subscription_id		Gets an entity relation.

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_id	string	entity ID. Required.
relation_name	string	Relation Name. 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.

SELECT examples

get_relation

Gets an entity relation.

SELECT
id,
name,
etag,
relatedResourceId,
relatedResourceKind,
relatedResourceName,
relatedResourceType,
systemData,
type
FROM azure.security_insight.entity_relations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND entity_id = '{{ entity_id }}' -- required
AND relation_name = '{{ relation_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;