Update-AzSentinelAutomationRule

Module:

Az.SecurityInsights

Creates or updates the automation rule.

Syntax

Update-AzSentinelAutomationRule
      -Id <String>
      -ResourceGroupName <String>
      -WorkspaceName <String>
      [-SubscriptionId <String>]
      [-Action <IAutomationRuleAction[]>]
      [-DisplayName <String>]
      [-Order <Int32>]
      [-TriggeringLogicCondition <IAutomationRuleCondition[]>]
      [-TriggeringLogicExpirationTimeUtc <DateTime>]
      [-TriggeringLogicIsEnabled]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Update-AzSentinelAutomationRule
      -InputObject <ISecurityInsightsIdentity>
      [-Action <IAutomationRuleAction[]>]
      [-DisplayName <String>]
      [-Order <Int32>]
      [-TriggeringLogicCondition <IAutomationRuleCondition[]>]
      [-TriggeringLogicExpirationTimeUtc <DateTime>]
      [-TriggeringLogicIsEnabled]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Creates or updates the automation rule.

Examples

Example 1: Updates an automation rule

$LogicAppResourceId = Get-AzLogicApp -ResourceGroupName "myResourceGroup" -Name "Reset-AADPassword"
 $automationRuleAction = [Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.AutomationRuleRunPlaybookAction]::new()
 $automationRuleAction.Order = 1
 $automationRuleAction.ActionType = "RunPlaybook"
 $automationRuleAction.ActionConfigurationLogicAppResourceId = ($LogicAppResourceId.Id)
 $automationRuleAction.ActionConfigurationTenantId = (Get-AzContext).Tenant.Id
 Update-AzSentinelAutomationRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Id ((New-Guid).Guid) -Action $automationRuleAction -DisplayName "Run Playbook to reset AAD password" -Order 2 -TriggeringLogicIsEnabled

This command updates an automation rule

Parameters

-Action

The actions to execute when the automation rule is triggered To construct, see NOTES section for ACTION properties and create a hash table.

Type:	IAutomationRuleAction[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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

-DisplayName

The display name of the automation rule

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

-Order

The order of execution of the automation rule

Type:	Int32
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

-TriggeringLogicCondition

The conditions to evaluate to determine if the automation rule should be triggered on a given object

Type:	IAutomationRuleCondition[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TriggeringLogicExpirationTimeUtc

Determines when the automation rule should automatically expire and be disabled.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TriggeringLogicIsEnabled

Determines whether the automation rule is enabled or disabled.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
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.

ACTION <IAutomationRuleAction[]>: The actions to execute when the automation rule is triggered

• ActionType <AutomationRuleActionType>: The type of the automation rule action
• Order <Int32>: The order of execution of the automation rule action

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.