Set-AzAlertProcessingRule
Create or update an alert processing rule.
Syntax
Set-AzAlertProcessingRule
-ResourceGroupName <String>
-Name <String>
-Scope <System.Collections.Generic.List`1[System.String]>
-AlertProcessingRuleType <String>
[-Description <String>]
[-Enabled <String>]
[-Tag <Hashtable>]
[-FilterSeverity <String>]
[-FilterMonitorService <String>]
[-FilterMonitorCondition <String>]
[-FilterTargetResource <String>]
[-FilterTargetResourceType <String>]
[-FilterTargetResourceGroup <String>]
[-FilterAlertRuleId <String>]
[-FilterAlertRuleName <String>]
[-FilterDescription <String>]
[-FilterAlertContext <String>]
[-FilterSignalType <String>]
[-ScheduleStartDateTime <String>]
[-ScheduleEndDateTime <String>]
[-ScheduleTimeZone <String>]
[-ScheduleReccurenceType <String>]
[-ScheduleReccurence2Type <String>]
[-ScheduleReccurenceDaysOfWeek <String>]
[-ScheduleReccurence2DaysOfWeek <String>]
[-ScheduleReccurenceDaysOfMonth <String>]
[-ScheduleReccurence2DaysOfMonth <String>]
[-ScheduleReccurenceStartTime <String>]
[-ScheduleReccurence2StartTime <String>]
[-ScheduleReccurenceEndTime <String>]
[-ScheduleReccurence2EndTime <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzAlertProcessingRule
-InputObject <PSAlertProcessingRule>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzAlertProcessingRule
-ResourceGroupName <String>
-Name <String>
-Scope <System.Collections.Generic.List`1[System.String]>
-AlertProcessingRuleType <String>
-ActionGroupId <String>
[-Description <String>]
[-Enabled <String>]
[-Tag <Hashtable>]
[-FilterSeverity <String>]
[-FilterMonitorService <String>]
[-FilterMonitorCondition <String>]
[-FilterTargetResource <String>]
[-FilterTargetResourceType <String>]
[-FilterTargetResourceGroup <String>]
[-FilterAlertRuleId <String>]
[-FilterAlertRuleName <String>]
[-FilterDescription <String>]
[-FilterAlertContext <String>]
[-FilterSignalType <String>]
[-ScheduleStartDateTime <String>]
[-ScheduleEndDateTime <String>]
[-ScheduleTimeZone <String>]
[-ScheduleReccurenceType <String>]
[-ScheduleReccurence2Type <String>]
[-ScheduleReccurenceDaysOfWeek <String>]
[-ScheduleReccurence2DaysOfWeek <String>]
[-ScheduleReccurenceDaysOfMonth <String>]
[-ScheduleReccurence2DaysOfMonth <String>]
[-ScheduleReccurenceStartTime <String>]
[-ScheduleReccurence2StartTime <String>]
[-ScheduleReccurenceEndTime <String>]
[-ScheduleReccurence2EndTime <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Set-AzAlertProcessingRule creates or updates an alert processing rule.
Examples
Example 1
Set-AzAlertProcessingRule -ResourceGroupName "test-rg" -Name "AddActionGroupToSubscription" -Scope "/subscriptions/MySubscriptionId" -Description "Add ActionGroup1 to all alerts in the subscription" -Enabled "True" -AlertProcessingRuleType "AddActionGroups" -ActionGroupId "/subscriptions/MySubscriptionId/resourcegroups/MyResourceGroup1/providers/microsoft.insights/actiongroups/ActionGroup1"
This cmdlet creates an alert processing rule that adds an action group to all alerts in a resource group.
Example 2
Set-AzAlertProcessingRule -ResourceGroupName "test-rg" -Name "AddActionGroupsBySeverity" -Scope "/subscriptions/MySubscriptionId" -Description "Add AGId1 and AGId2 to all Sev0 and Sev1 alerts in these resourceGroups" -Enabled "True" -AlertProcessingRuleType "AddActionGroups" -ActionGroupId "/subscriptions/MySubscriptionId/resourcegroups/MyResourceGroup1/providers/microsoft.insights/actiongroups/ActionGroup1,/subscriptions/MySubscriptionId/resourceGroups/MyResourceGroup2/providers/microsoft.insights/actionGroups/MyActionGroup2" -FilterMonitorCondition "Equals:Sev0,Sev1"
This cmdlet creates a rule that adds two action groups to all Sev0 and Sev1 alerts
Parameters
-ActionGroupId
Action Group Ids which are to be notified, Comma separated list of values
Required only if alert processing rule type is AddActionGroups.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AlertProcessingRuleType
Alert Processing rule Type. Allowed values: AddActionGroups, RemoveAllActionGroups.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, 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
-Description
Description of Alert Processing Rule
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Enabled
Indicate if the given alert processing rule is enabled or disabled (default is enabled). Allowed values: False, True.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FilterAlertContext
Expected format - {<operation>:<comma separated list of values>} operation: one of <Equals, NotEquals, Contains, DoesNotContain>
For eg.
Contains:smartgroups
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FilterAlertRuleId
Expected format - {<operation>:<comma separated list of values>} operation: one of <Equals, NotEquals, Contains, DoesNotContain>
For eg.
Equals:/subscriptions/MySubscriptionId/resourceGroups/abvarma/providers/microsoft.insights/metricAlerts/test-mrmc-vm-abvarma
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FilterAlertRuleName
Expected format - {<operation>:<comma separated list of values>} operation: one of <Equals, NotEquals, Contains, DoesNotContain>
For eg.
Equals:ARM Name Test1,ARM Name Test2
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FilterDescription
Expected format - {<operation>:<comma separated list of values>} operation: one of <Equals, NotEquals, Contains, DoesNotContain>
For eg.
Contains:Test Alert
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FilterMonitorCondition
Expected format - {<operation>:<comma separated list of values>} operation: one of <Equals, NotEquals, Contains, DoesNotContain>
For eg.
NotEquals:Resolved
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FilterMonitorService
Expected format - {<operation>:<comma separated list of values>} operation: one of <Equals, NotEquals, Contains, DoesNotContain>
For eg.
Equals:Platform,Log Analytics
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FilterSeverity
Expected format - {<operation>:<comma separated list of values>} severity: one of <Sev0, Sev1, Sev2, Sev3, Sev4>.
For eg.
Equals:Sev0,Sev1
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FilterSignalType
Expected format - {<operation>:<comma separated list of values>} operation: one of <Equals, NotEquals, Contains, DoesNotContain>
For eg.
Equals:Metric
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FilterTargetResource
Expected format - {<operation>:<comma separated list of values>} operation: one of <Equals, NotEquals, Contains, DoesNotContain>
For eg.
Equals:mySQLDataBaseName
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FilterTargetResourceGroup
Expected format - {<operation>:<comma separated list of values>} operation: one of <Equals, NotEquals, Contains, DoesNotContain>
For eg.
NotEquals:/subscriptions/<subscriptionID>/resourceGroups/test
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FilterTargetResourceType
Expected format - {<operation>:<comma separated list of values>} operation: one of <Equals, NotEquals, Contains, DoesNotContain>
For eg.
Contains:Virtual Machines,Storage Account
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
The alert processing rule resource
ByInputObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
Alert Processing Rule Name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: ResourceId
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
Resource Group Name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleEndDateTime
End Date Time. Format 2022-09-21 06:00:00
Should be mentioned in case of Recurrent Schedule - Daily, Weekly or Monthly.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleReccurence2DaysOfMonth
List of recurrence pattern values Expected format For a monthly recurrence type.
comma separated list of values For eg. 1,3,12
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleReccurence2DaysOfWeek
List of recurrence pattern values Expected format For a weekly recurrence type.
comma separated list of values For eg. Monday,Saturday
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleReccurence2EndTime
Reccurence Start Time in the timezone of ScheduleTimeZone parameter. Format 06:00:00
Should be mentioned in case of Recurrent Schedule - Daily, Weekly or Monthly.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleReccurence2StartTime
Reccurence Start Time in the timezone of ScheduleTimeZone parameter. Format 06:00:00
Should be mentioned in case of Recurrent Schedule - Daily, Weekly or Monthly.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleReccurence2Type
Specifies when the processing rule should be applied.
Allowed values: Daily, Monthly, Weekly.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleReccurenceDaysOfMonth
List of recurrence pattern values Expected format For a monthly recurrence type.
comma separated list of values For eg. 1,3,12
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleReccurenceDaysOfWeek
List of recurrence pattern values Expected format For a weekly recurrence type.
comma separated list of values For eg. Monday,Saturday
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleReccurenceEndTime
Reccurence Start Time in the timezone of ScheduleTimeZone parameter. Format 06:00:00
Should be mentioned in case of Recurrent Schedule - Daily, Weekly or Monthly.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleReccurenceStartTime
Reccurence Start Time in the timezone of ScheduleTimeZone parameter. Format 06:00:00
Should be mentioned in case of Recurrent Schedule - Daily, Weekly or Monthly.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleReccurenceType
Specifies when the processing rule should be applied.
Allowed values: Daily, Monthly, Weekly.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleStartDateTime
Start Date Time. Format 2022-09-21 06:00:00
Should be mentioned in case of Recurrent Schedule - Daily, Weekly or Monthly.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleTimeZone
Schedule time zone. Default: UTC.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Scope
List of resource IDs, Comma separated list of values
The rule will apply to alerts that fired on resources within that scope
Parameter properties
Type: List<T> [ String ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
Alert Processing rule tags.
For eg.
@{"tag1" = "key1";"tag2" = "key2"}
Use {} to clear existing tags.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BySimplifiedFormatSuppressionActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BySimplifiedFormatActionGroupActionRule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False 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 .
Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSActionRule
Outputs
Microsoft.Azure.Commands.AlertsManagement.OutputModels.PSActionRule
