Edit

Share via


Get-AzAlertProcessingRule

Get AlertProcessing Rules Information

Syntax

ListAlertProcessingRules (Default)

Get-AzAlertProcessingRule
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

AlertProcessingRuleByName

Get-AzAlertProcessingRule
    -Name <String>
    -ResourceGroupName <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ListAlertProcessingRulesByResourceGroupName

Get-AzAlertProcessingRule
    -ResourceGroupName <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ResourceId

Get-AzAlertProcessingRule
    -ResourceId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

Get-AzAlertProcessingRule cmdlet gets alert processing rules configured.

Examples

Example 1

Get-AzAlertProcessingRule

List all alert processing rules configured in subscription.

Example 2

Get-AzAlertProcessingRule -ResourceGroupName "test-rg"

List all alert processing rules configured in resource group test-rg.

Example 3

Get-AzAlertProcessingRule -ResourceGroupName "test-rg" -Name "Test-AlertProcessing-Rule" | Format-List

Get the alert processing rule with name Test-AlertProcessing-Rule in test-rg resource group.

Parameters

-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

-Name

Name of alert processing rule.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AlertProcessingRuleByName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

Resource Group Name in which alert processing rule resides.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AlertProcessingRuleByName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ListAlertProcessingRulesByResourceGroupName
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

ResourceId
Position:Named
Mandatory:True
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.

Inputs

None

Outputs

PSAlertProcessingRule