Get-AzMetricAlertRuleV2
Gets V2 (non-classic) metric alert rules
Syntax
ByResourceGroupName (Default)
Get-AzMetricAlertRuleV2
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByRuleName
Get-AzMetricAlertRuleV2
-ResourceGroupName <String>
-Name <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByRuleId
Get-AzMetricAlertRuleV2
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzMetricAlertRuleV2 cmdlet gets a metric alert rule by its name or URI, or all metric alert rules from a specified resource group or subscription.
Examples
Example 1: Get all metric alert rules in current subscription
Get-AzMetricAlertRuleV2
TargetResourceId : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricResourceGroup/providers/Microsoft.KeyVault/vaults/GenevaRPKeyVault
Criteria : {Metric1}
Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/sampleresourcegroup/providers/Microsoft.Insights/actiongroups/scnewactiongroup}
ResourceGroup : metricResourceGroup
Description : fdafda
Severity : 3
Enabled : True
Scopes : {/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricResourceGroup/providers/Microsoft.KeyVault/vaults/GenevaRPKeyVault}
EvaluationFrequency : 00:01:00
WindowSize : 00:05:00
TargetResourceType :
TargetResourceRegion :
AutoMitigate :
LastUpdatedTime :
Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricResourceGroup/providers/Microsoft.Insights/metricAlerts/Rule1
Name : Rule1
Type : Microsoft.Insights/metricAlerts
Location : global
Tags : {}
Criteria : {Metric1}
Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/sampleresourcegroup/providers/Microsoft.Insights/actiongroups/scnewactiongroup}
ResourceGroup : SampleResourceGroup
Description : Testing 1 minute granuarity
Severity : 3
Enabled : True
Scopes : {/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Compute/virtualMachines/SCCMDemo4}
EvaluationFrequency : 00:01:00
WindowSize : 00:01:00
TargetResourceType : Microsoft.Compute/virtualMachines
TargetResourceRegion : eastus
AutoMitigate : True
LastUpdatedTime :
Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Insights/metricAlerts/Rule2
Name : Rule2
Type : Microsoft.Insights/metricAlerts
Location : global
Tags : {}
This command gets all the metric alert rules in the current subscription.
Example 2: Get all metric alert rules in a resource group
Get-AzMetricAlertRuleV2 -ResourceGroupName metricAlertsRG
Criteria : {Metric1}
Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/default-activitylogalerts/pr
oviders/Microsoft.Insights/actiongroups/emails}
ResourceGroup : metricAlertsRG
Description : Test Classic VM alert - CPU Usage
Severity : 3
Enabled : True
Scopes : {/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricAlertsRG/providers/Micr
osoft.ClassicCompute/virtualMachines/VM1}
EvaluationFrequency : 00:01:00
WindowSize : 00:05:00
TargetResourceType : Microsoft.ClassicCompute/virtualMachines
TargetResourceRegion : southcentralus
AutoMitigate : True
LastUpdatedTime :
Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricAlertsRG/providers/micro
soft.insights/metricAlerts/Test%20Classic%20VM%20alert%20-%20CPU%20Usage
Name : Test Classic VM alert - CPU Usage
Type : Microsoft.Insights/metricAlerts
Location : global
Tags : {}
This command gets all the metric alert rules in the resource group named metricAlertsRG.
Example 3: Get a metric alert rule by name
Get-AzMetricAlertRuleV2 -ResourceGroupName metricAlertsRG -Name PS3182019
Criteria : {metric1}
Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/default-activitylogalerts/providers/Microsoft.Insights/actiongroups/demo}
ResourceGroup : metricAlertsRG
Description : This is description
Severity : 1
Enabled : True
Scopes : {/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricAlertsRG/providers/Microsoft.Compute/virtualMachines/VM1,
/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricAlertsRG/providers/Microsoft.Compute/virtualMachines/VM2}
EvaluationFrequency : 00:05:00
WindowSize : 00:05:00
TargetResourceType : Microsoft.Compute/virtualMachines
TargetResourceRegion : eastus
AutoMitigate :
LastUpdatedTime :
Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/metricAlertsRG/providers/Microsoft.Insights/metricAlerts/PS3182019
Name : PS3182019
Type : Microsoft.Insights/metricAlerts
Location : global
Tags :
This command gets the metric alert rule named PS3182019 in the resource group named metricAlertsRG.
Example 4: Get a metric alert rule by ruleID
Get-AzMetricAlertRuleV2 -ResourceId /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Insights/metricAlerts/MyMetricAlertRule
TargetResourceId : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Insights/components/alertstestFunction
Criteria : {Metric1}
Actions : {/subscriptions/00000000-0000-0000-0000-0000000/resourcegroups/default-activitylogalerts/providers/Microsoft.Insights/actiongroups/emails}
ResourceGroup : SampleResourceGroup
Description : Test Description
Severity : 3
Enabled : True
Scopes : {/subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Insights/components/alertstestFunction}
EvaluationFrequency : 00:01:00
WindowSize : 00:05:00
TargetResourceType :
TargetResourceRegion :
AutoMitigate :
LastUpdatedTime :
Id : /subscriptions/00000000-0000-0000-0000-0000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Insights/metricAlerts/MyMetricAlertRule
Name : MyMetricAlertRule
Type : Microsoft.Insights/metricAlerts
Location : global
Tags :
This command gets the metric alert rule with the given resource ID.
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
The Name of metric alert rule
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByRuleName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
The ResourceGroupName
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ResourceGroup |
Parameter sets
ByResourceGroupName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceId
The Rule Id of metric alert rule
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByRuleId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| 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.
