Get-AzSentinelAlertRuleAction

Module:

Az.SecurityInsights Module

Gets the action of alert rule.

Syntax

List (Default)

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

GetViaIdentityAlertRule

Get-AzSentinelAlertRuleAction
    -Id <String>
    -AlertRuleInputObject <ISecurityInsightsIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get

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

GetViaIdentity

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

Description

Gets the action of alert rule.

Examples

Example 1: List all Actions for a given Alert Rule

Get-AzSentinelAlertRuleAction -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -RuleId "myRuleId"

LogicAppResourceId : /subscriptions/174b1a81-c53c-4092-8d4a-7210f6a44a0c/resourceGroups/myResourceGroup/providers/Microsoft.Logic/workflows/A-Demo-1
Name               : f32239c5-cb9c-48da-a3f6-bd5bd3d924a4
WorkflowId         : 3c73d72560fa4cb6a72a0f10d3a80940

LogicAppResourceId : /subscriptions/274b1a41-c53c-4092-8d4a-7210f6a44a0c/resourceGroups/myResourceGroup/providers/Microsoft.Logic/workflows/EmptyPlaybook
Name               : cf815c77-bc65-4c02-946f-d81e15e9a100
WorkflowId         : 1ac8ccb8bd134253b4baf0c75fe3ecc6

This command lists all Actions for a given Alert Rule.

Parameters

-AlertRuleInputObject

Identity Parameter

Parameter properties

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

Parameter sets

GetViaIdentityAlertRule

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

-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

Action ID

Parameter properties

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

Parameter sets

GetViaIdentityAlertRule

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

-InputObject

Identity Parameter

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

-RuleId

Alert rule ID

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

IActionResponse