Get-AzSentinelEntityQueryTemplate
Gets an entity query.
Syntax
Get-AzSentinelEntityQueryTemplate
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
-WorkspaceName <String>
[-Kind <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzSentinelEntityQueryTemplate
-Id <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
-WorkspaceName <String>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzSentinelEntityQueryTemplate
-InputObject <ISecurityInsightsIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets an entity query.
Examples
Example 1: List all Entity Query Templates
Get-AzSentinelEntityQueryTemplate -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName"
Title : The user has created an account
Description : This activity displays account creation events performed by the user
InputEntityType : Account
Kind : Activity
Name : d6d08c94-455f-4ea5-8f76-fc6c0c442cfa
Title : The user has deleted an account
Description : This activity displays account deletion events performed by the user
InputEntityType : Account
Kind : Activity
Name : e0459780-ac9d-4b72-8bd4-fecf6b46a0a1
This command lists all Entity Query Templates under a Microsoft Sentinel workspace.
Example 2: Get an Entity Query Template
Get-AzSentinelEntityQueryTemplate -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "d6d08c94-455f-4ea5-8f76-fc6c0c442cfa"
Description : This activity displays account creation events performed by the user
InputEntityType : Account
Kind : Activity
Name : d6d08c94-455f-4ea5-8f76-fc6c0c442cfa
This command gets an Entity Query Template.
Example 3: Get an Entity Query Template by object Id
$EntityQueryTemplates = Get-AzSentinelEntityQueryTemplate -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName"
$EntityQueryTemplates[0] | Get-AzSentinelEntityQueryTemplate
Description : This activity displays account creation events performed by the user
InputEntityType : Account
Kind : Activity
Name : d6d08c94-455f-4ea5-8f76-fc6c0c442cfa
This command gets a Entity Query Template 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 template ID
Type: | String |
Aliases: | EntityQueryTemplateId |
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 template 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
Outputs
Azure PowerShell