Edit

Get-AzSentinelAutomationRule

  • Reference
Module:
Az.SecurityInsights

Gets the automation rule.

Syntax

Get-AzSentinelAutomationRule
   -ResourceGroupName <String>
   -WorkspaceName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSentinelAutomationRule
   -Id <String>
   -ResourceGroupName <String>
   -WorkspaceName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSentinelAutomationRule
   -InputObject <ISecurityInsightsIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets the automation rule.

Examples

Example 1: List all Automation Rules

Get-AzSentinelAutomationRule -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName"

DisplayName                 : VIP automation rule
CreatedByEmail              : luke@contoso.com
CreatedByUserPrincipalName  : luke@contoso.com
TriggeringLogicIsEnabled    : True
TriggeringLogicTriggersOn   : Incidents
TriggeringLogicTriggersWhen : Created
Name                       	: 2f32af32-ad13-4fbb-9fbc-e19e0e7ff767

This command lists all Automation Rules under a Microsoft Sentinel workspace.

Example 2: Get an Automation Rule

Get-AzSentinelAutomationRule -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Id "2f32af32-ad13-4fbb-9fbc-e19e0e7ff767"

DisplayName                 : VIP automation rule
CreatedByEmail              : luke@contoso.com
CreatedByUserPrincipalName  : luke@contoso.com
TriggeringLogicIsEnabled    : True
TriggeringLogicTriggersOn   : Incidents
TriggeringLogicTriggersWhen : Created
Name                       	: 2f32af32-ad13-4fbb-9fbc-e19e0e7ff767

This command gets an Automation 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

Automation rule ID

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

-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

IAutomationRule

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.