Edit

Get-AzSentinelAlertRuleAction

  • Reference
Module:
Az.SecurityInsights

Gets the action of alert rule.

Syntax

Get-AzSentinelAlertRuleAction
   -ResourceGroupName <String>
   -RuleId <String>
   -WorkspaceName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSentinelAlertRuleAction
   -Id <String>
   -ResourceGroupName <String>
   -RuleId <String>
   -WorkspaceName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
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

-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

Action ID

Type:String
Aliases:ActionId
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

-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

-RuleId

Alert rule ID

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

IActionResponse

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <ISecurityInsightsIdentity>: Identity Parameter

  • [ActionId <String>]: Action ID
  • [AlertRuleTemplateId <String>]: Alert rule template ID
  • [AutomationRuleId <String>]: Automation rule ID
  • [BookmarkId <String>]: Bookmark ID
  • [ConsentId <String>]: consent ID
  • [DataConnectorId <String>]: Connector ID
  • [EntityId <String>]: entity ID
  • [EntityQueryId <String>]: entity query ID
  • [EntityQueryTemplateId <String>]: entity query template ID
  • [Id <String>]: Resource identity path
  • [IncidentCommentId <String>]: Incident comment ID
  • [IncidentId <String>]: Incident ID
  • [MetadataName <String>]: The Metadata name.
  • [Name <String>]: Threat intelligence indicator name field.
  • [RelationName <String>]: Relation Name
  • [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
  • [RuleId <String>]: Alert rule ID
  • [SentinelOnboardingStateName <String>]: The Sentinel onboarding state name. Supports - default
  • [SettingsName <String>]: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba
  • [SourceControlId <String>]: Source control Id
  • [SubscriptionId <String>]: The ID of the target subscription.
  • [WorkspaceName <String>]: The name of the workspace.