Get-AzSentinelEntityQuery

Reference

Module:: Az.SecurityInsights

Gets an entity query.

Syntax

Get-AzSentinelEntityQuery
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -WorkspaceName <String>
   [-Kind <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzSentinelEntityQuery
   -Id <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -WorkspaceName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzSentinelEntityQuery
   -InputObject <ISecurityInsightsIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets an entity query.

Examples

Example 1: List all Entity Queries

Get-AzSentinelEntityQuery -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName"

DisplayName     : Related entities
DataSource      : {SecurityAlert}
Name            : 98b974fd-cc64-48b8-9bd0-3a209f5b944b
InputEntityType : SecurityAlert

DisplayName     : Related alerts
DataSource      : {SecurityAlert}
Name            : 055a5692-555f-42bd-ac17-923a5a9994ed
InputEntityType : Host

This command lists all Entity Queries under a Microsoft Sentinel workspace.

Example 2: Get an Entity Query

Get-AzSentinelEntityQuery -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "myEntityQueryId"

DisplayName     : Related entities
DataSource      : {SecurityAlert}
Name            : 98b974fd-cc64-48b8-9bd0-3a209f5b944b
InputEntityType : SecurityAlert
QueryTemplate   : let GetAlertRelatedEntities = (v_SecurityAlert_SystemAlertId:string){
                                              SecurityAlert
                                              | where SystemAlertId == v_SecurityAlert_SystemAlertId
                                              | project entities = todynamic(Entities)
                                              | mv-expand entities
                                              | project-rename entity=entities};
                                              GetAlertRelatedEntities('<systemAlertId>')

This command gets an Entity Query.

Example 3: Get an Entity Query by object Id

$EntityQueries = Get-AzSentinelEntityQuery -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName"
 $EntityQueries[0] | Get-AzSentinelEntityQuery

DisplayName     : Related entities
DataSource      : {SecurityAlert}
Name            : 98b974fd-cc64-48b8-9bd0-3a209f5b944b
InputEntityType : SecurityAlert
QueryTemplate   : let GetAlertRelatedEntities = (v_SecurityAlert_SystemAlertId:string){
                                              SecurityAlert
                                              | where SystemAlertId == v_SecurityAlert_SystemAlertId
                                              | project entities = todynamic(Entities)
                                              | mv-expand entities
                                              | project-rename entity=entities};
                                              GetAlertRelatedEntities('<systemAlertId>')

This command gets a Entity Query by object.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

entity query ID

Type:	String
Aliases:	EntityQueryId
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	ISecurityInsightsIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Kind

The entity query kind we want to fetch

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceName

The name of the workspace.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

ISecurityInsightsIdentity

Outputs

IEntityQuery

Share via