Get-AzSentinelAlertRuleTemplate

Module:

Az.SecurityInsights Module

Gets the alert rule template.

Syntax

List (Default)

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

Get

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

GetViaIdentity

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

Description

Gets the alert rule template.

Examples

Example 1: List all Alert Rule Templates

Get-AzSentinelAlertRuleTemplate -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName"

DisplayName        : TI map IP entity to GitHub_CL
Description        : Identifies a match in GitHub_CL table from any IP IOC from TI
CreatedDateUtc     : 8/27/2019 12:00:00 AM
LastUpdatedDateUtc : 10/19/2021 12:00:00 AM
Kind               : Scheduled
Severity           : Medium
Name               : aac495a9-feb1-446d-b08e-a1164a539452

DisplayName        : Accessed files shared by temporary external user
Description        : This detection identifies an external user is added to a Team or Teams chat
                     and shares a files which is accessed by many users (>10) and the users is removed within short period of time. This might be
                     an indicator of suspicious activity.
CreatedDateUtc     : 8/18/2020 12:00:00 AM
LastUpdatedDateUtc : 1/3/2022 12:00:00 AM
Kind               : Scheduled
Severity           : Low
Name               : bff058b2-500e-4ae5-bb49-a5b1423cbd5b

This command lists all Alert Rule Templates under a Microsoft Sentinel workspace.

Example 2: Get an Alert Rule Template

Get-AzSentinelAlertRuleTemplate -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "myRuaac495a9-feb1-446d-b08e-a1164a539452leTemplateId"

DisplayName        : TI map IP entity to GitHub_CL
Description        : Identifies a match in GitHub_CL table from any IP IOC from TI
CreatedDateUtc     : 8/27/2019 12:00:00 AM
LastUpdatedDateUtc : 10/19/2021 12:00:00 AM
Kind               : Scheduled
Severity           : Medium
Name               : aac495a9-feb1-446d-b08e-a1164a539452

This command gets an Alert Rule Template.

Parameters

-DefaultProfile

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

Parameter properties

Type:	PSObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzureRMContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Id

Alert rule template ID

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AlertRuleTemplateId, TemplateId

Parameter sets

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

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

Parameter properties

Type:	ISecurityInsightsIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

List

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SubscriptionId

The ID of the target subscription.

Parameter properties

Type:	String[]
Default value:	(Get-AzContext).Subscription.Id
Supports wildcards:	False
DontShow:	False

Parameter sets

List

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WorkspaceName

The name of the workspace.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

List

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

ISecurityInsightsIdentity

Outputs

IAlertRuleTemplate