Add-AzMetricAlertRule

Module:

Az.Monitor

Adds or updates a claasic metric-based alert rule (already retired on public cloud). To create a new metric alert rule, use the Add-AzMetricAlertRuleV2 cmdlet.

Syntax

Add-AzMetricAlertRule
   -WindowSize <TimeSpan>
   -Operator <ConditionOperator>
   -Threshold <Double>
   -TargetResourceId <String>
   -MetricName <String>
   -TimeAggregationOperator <TimeAggregationOperator>
   -Location <String>
   [-Description <String>]
   [-DisableRule]
   -ResourceGroupName <String>
   -Name <String>
   [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-AzMetricAlertRule cmdlet adds or updates a metric-based alert rule. The added rule is associated with a resource group and has a name. This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource.

Examples

Example 1: Add a metric alert rule to a website

Add-AzMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup "Default-Web-EastUS" -Operator GreaterThan -Threshold 2 -WindowSize 00:05:00 -MetricName "Requests" -Description "Pura Vida" -TimeAggregationOperator Total

RequestId                                                                                                    StatusCode
---------                                                                                                    ----------
33574ccf-0b01-43b4-aa97-87e6bbcf1c11                                                                         Created

This command creates a metric alert rule for a website.

Example 2: Disable a rule

Add-AzMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup Default-Web-EastUS -Operator GreaterThan -Threshold 2 -WindowSize 00:05:00 -MetricName "Requests" -TimeAggregationOperator Total

RequestId                                                                                                    StatusCode
---------                                                                                                    ----------
96c489f1-8529-46e1-a76d-2c1463ca3116                                                                                 OK

This command disables a rule. If the rule does not exist, it creates it disabled. If the rule exists, then it just disables it.

Example 3: Add a rule with actions

Add-AzMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup "Default-Web-EastUS" -Operator GreaterThan -Threshold 1 -TargetResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -MetricName "Requests" -TimeAggregationOperator Total

RequestId                                                                                                    StatusCode
---------                                                                                                    ----------
9a5bc388-c7ac-4dc6-aa70-f4bc29c2c712                                                                                 OK

This command creates a metric alert rule for a website.

Parameters

-Action

Specifies a comma-separated list of actions.

Type:	List<T>[RuleAction]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
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 credentials, account, tenant, and subscription used for communication with azure

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Specifies a description of the rule.

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

-DisableRule

Disables the rule. If you do not specify this parameter, the rule is enabled.

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

-Location

Specifies the location where the rule is defined.

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

-MetricName

Specifies the name of the metric the rule is monitoring. Specify this parameter only for metric-based rules.

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

-Name

Specifies the name of the rule.

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

-Operator

Specifies the relational operator for the condition of the rule. The acceptable values for this parameter are:

• GreaterThan
• GreaterThanOrEqual
• LessThan
• LessThanOrEqual

Type:	ConditionOperator
Accepted values:	GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Specifies the name of the resource group for the rule.

Type:	String
Aliases:	ResourceGroup
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-TargetResourceId

Specifies the ID of the resource the rule is monitoring. NOTE: This property cannot be updated for an existing alert rule.

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

-Threshold

Specifies the threshold of the rule.

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

-TimeAggregationOperator

Specifies the aggregation operator to apply to the time window when the rule is being evaluated.

Type:	Nullable<T>[TimeAggregationOperator]
Accepted values:	Average, Minimum, Maximum, Total, Last
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

-WindowSize

Specifies the time window size for the rule to compute its data.

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

Inputs

TimeSpan

ConditionOperator

Double

String

Nullable<T>[[Microsoft.Azure.Management.Monitor.Management.Models.TimeAggregationOperator, Microsoft.Azure.PowerShell.Cmdlets.Monitor, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

SwitchParameter

List<T>[[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction, Microsoft.Azure.PowerShell.Cmdlets.Monitor, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Outputs

PSAddAlertRuleOperationResponse

Related Links

• Add-AzWebtestAlertRule
• Get-AzAlertHistory
• Get-AzAlertRule
• New-AzAlertRuleEmail
• New-AzAlertRuleWebhook
• Remove-AzAlertRule