Skip to content

Commit 88af104

Browse files
PMEds28PMEds28
authored
Merge pull request #215552 from AbbyMSFT/log-alert-ps
Adding new powershell commands for log alerts
2 parents 20e92f6 + acc854e commit 88af104

File tree

2 files changed

+30
-74
lines changed

2 files changed

+30
-74
lines changed

‎articles/azure-monitor/alerts/alerts-create-new-alert-rule.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,7 @@ You can create a new alert rule using the [Azure CLI](/cli/azure/get-started-wit
282282
### [Log alert](#tab/log)
283283
284284
To create a log alert rule that monitors count of system event errors:
285+
285286
```azurecli
286287
az monitor scheduled-query create -g {ResourceGroup} -n {nameofthealert} --scopes {vm_id} --condition "count \'union Event, Syslog | where TimeGenerated > a(1h) | where EventLevelName == \"Error\" or SeverityLevel== \"err\"\' > 2" --description {descriptionofthealert}
287288
```
@@ -299,10 +300,10 @@ You can create a new alert rule using the [Azure CLI](/cli/azure/get-started-wit
299300
- [az monitor activity-log alert action-group](/cli/azure/monitor/activity-log/alert/action-group): Add an action group to the activity log alert rule.
300301
301302
---
302-
303303
## Create a new alert rule using PowerShell
304304
305305
- To create a metric alert rule using PowerShell, use this cmdlet: [Add-AzMetricAlertRuleV2](/powershell/module/az.monitor/add-azmetricalertrulev2)
306+
- To create a log alert rule using PowerShell, use this cmdlet: [New-AzScheduledQueryRule](/powershell/module/az.monitor/new-azscheduledqueryrule)
306307
- To create an activity log alert rule using PowerShell, use this cmdlet: [Set-AzActivityLogAlert](/powershell/module/az.monitor/set-azactivitylogalert)
307308
308309
## Create an activity log alert rule from the Activity log pane
@@ -450,7 +451,7 @@ The *sampleActivityLogAlert.parameters.json* file contains the values provided f
450451

451452
## Changes to log alert rule creation experience
452453

453-
If you're creating a new log alert rule, please note that current alert rule wizard is a little different from the earlier experience:
454+
If you're creating a new log alert rule, note that current alert rule wizard is a little different from the earlier experience:
454455

455456
- Previously, search results were included in the payload of the triggered alert and its associated notifications. The email included only 10 rows from the unfiltered results while the webhook payload contained 1000 unfiltered results. To get detailed context information about the alert so that you can decide on the appropriate action:
456457
- We recommend using [Dimensions](alerts-types.md#narrow-the-target-using-dimensions). Dimensions provide the column value that fired the alert, giving you context for why the alert fired and how to fix the issue.

‎articles/azure-monitor/alerts/alerts-manage-alert-rules.md

Lines changed: 27 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -49,45 +49,20 @@ To enable recommended alert rules:
4949

5050
## Manage metric alert rules with the Azure CLI
5151

52-
This section describes how to do manage metric alert rules using the cross-platform [Azure CLI](/cli/azure/get-started-with-azure-cli). The following examples use [Azure Cloud Shell](../../cloud-shell/overview.md).
52+
This section describes how to manage metric alert rules using the cross-platform [Azure CLI](/cli/azure/get-started-with-azure-cli). The following examples use [Azure Cloud Shell](../../cloud-shell/overview.md).
5353

5454
1. In the [portal](https://portal.azure.com/), select **Cloud Shell**.
55-
56-
You can use commands with ``--help`` option to learn more about the command and how to use it. For example, the following command shows you the list of commands available for creating, viewing, and managing metric alerts.
57-
58-
```azurecli
59-
az monitor metrics alert --help
60-
```
61-
62-
### View all the metric alerts in a resource group
63-
64-
```azurecli
65-
az monitor metrics alert list -g {ResourceGroup}
66-
```
67-
68-
### See the details of a particular metric alert rule
69-
70-
Use the name or the resource ID of the rule in the following commands:
71-
72-
```azurecli
73-
az monitor metrics alert show -g {ResourceGroup} -n {AlertRuleName}
74-
```
75-
76-
```azurecli
77-
az monitor metrics alert show --ids {RuleResourceId}
78-
```
79-
80-
### Disable a metric alert rule
81-
82-
```azurecli
83-
az monitor metrics alert update -g {ResourceGroup} -n {AlertRuleName} --enabled false
84-
```
85-
86-
### Delete a metric alert rule
87-
88-
```azurecli
89-
az monitor metrics alert delete -g {ResourceGroup} -n {AlertRuleName}
90-
```
55+
1. Use these options of the `az monitor metrics alert` CLI command in this table:
56+
57+
58+
|What you want to do|CLI command |
59+
|---------|---------|
60+
|View all the metric alerts in a resource group|`az monitor metrics alert list -g {ResourceGroup}`|
61+
|See the details of a metric alert rule|`az monitor metrics alert show -g {ResourceGroup} -n {AlertRuleName}`|
62+
| |`az monitor metrics alert show --ids {RuleResourceId}`|
63+
|Disable a metric alert rule|`az monitor metrics alert update -g {ResourceGroup} -n {AlertRuleName} --enabled false`|
64+
|Delete a metric alert rule|`az monitor metrics alert delete -g {ResourceGroup} -n {AlertRuleName}`|
65+
|Learn more about the command|`az monitor metrics alert --help`|
9166

9267
## Manage metric alert rules with PowerShell
9368

@@ -115,41 +90,17 @@ This section describes how to manage log alerts using the cross-platform [Azure
11590
11691

11792
1. In the [portal](https://portal.azure.com/), select **Cloud Shell**.
118-
119-
You can use commands with ``--help`` option to learn more about the command and how to use it. For example, the following command shows you the list of commands available for creating, viewing, and managing log alerts.
120-
121-
```azurecli
122-
az monitor scheduled-query --help
123-
```
124-
125-
### View all the log alert rules in a resource group
126-
127-
```azurecli
128-
az monitor scheduled-query list -g {ResourceGroup}
129-
```
130-
131-
### See the details of a log alert rule
132-
133-
Use the name or the resource ID of the rule in the following command:
134-
135-
```azurecli
136-
az monitor scheduled-query show -g {ResourceGroup} -n {AlertRuleName}
137-
```
138-
```azurecli
139-
az monitor scheduled-query show --ids {RuleResourceId}
140-
```
141-
142-
### Disable a log alert rule
143-
144-
```azurecli
145-
az monitor scheduled-query update -g {ResourceGroup} -n {AlertRuleName} --disabled true
146-
```
147-
148-
### Delete a log alert rule
149-
150-
```azurecli
151-
az monitor scheduled-query delete -g {ResourceGroup} -n {AlertRuleName}
152-
```
93+
1. Use these options of the `az monitor scheduled-query alert` CLI command in this table:
94+
95+
96+
|What you want to do|CLI command |
97+
|---------|---------|
98+
|View all the log alert rules in a resource group|`az monitor scheduled-query list -g {ResourceGroup}`|
99+
|See the details of a log alert rule|`az monitor scheduled-query show -g {ResourceGroup} -n {AlertRuleName}`|
100+
| |`az monitor scheduled-query show --ids {RuleResourceId}`|
101+
|Disable a log alert rule|`az monitor scheduled-query update -g {ResourceGroup} -n {AlertRuleName} --disabled true`|
102+
|Delete a log alert rule|`az monitor scheduled-query delete -g {ResourceGroup} -n {AlertRuleName}`|
103+
|Learn more about the command|`az monitor scheduled-query --help`|
153104

154105
### Manage log alert rules using the Azure Resource Manager CLI with [templates](./alerts-log-create-templates.md)
155106

@@ -164,6 +115,10 @@ az deployment group create \
164115

165116
A 201 response is returned on successful creation. 200 is returned on successful updates.
166117

118+
## Manage log alert rules with PowerShell
119+
120+
Log alert rules have this dedicated PowerShell cmdlet:
121+
- [New-AzScheduledQueryRule](/powershell/module/az.monitor/new-azscheduledqueryrule): Creates a new log alert rule or updates an existing log alert rule.
167122
## Manage activity log alert rules using PowerShell
168123

169124
Activity log alerts have these dedicated PowerShell cmdlets:

0 commit comments

Comments
 (0)