Remove-AzAlertProcessingRule
Deletes an alert processing rule
Syntax
ByName (Default)
Remove-AzAlertProcessingRule
-ResourceGroupName <String>
-Name <String>
[-DefaultProfile <IAzureContextContainer>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByResourceId
Remove-AzAlertProcessingRule
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzAlertProcessingRule
-InputObject <PSAlertProcessingRule>
[-DefaultProfile <IAzureContextContainer>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Remove-AzAlertProcessingRule cmdlet deletes an alert processing rule.
Examples
Example 1
Remove-AzAlertProcessingRule -ResourceGroupName "test-rg" -Name "AlertProcessingRuleName"
This cmdlet deletes the alert processing rule with name AlertProcessingRuleName in resource group test-rg
Parameters
-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
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
Name of alert processing rule
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByName
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PassThru
PassThru returns True if the remove alertProcessing rule succeeded. By default, this cmdlet does not generate any output.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False 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
ByName
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceId
Get Alert Processing rule by resource id.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByResourceId
Position: Named Mandatory: True 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 .
Outputs
