Skip to content

Commit 77d47cd

Browse files
author
Mahak Jain
committed
Update Help files
1 parent 8bba930 commit 77d47cd

11 files changed

+271
-171
lines changed

src/AlertsManagement/AlertsManagement/help/Az.AlertsManagement.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,35 +11,36 @@ Locale: en-US
1111
Manages alerts, smart groups and action rule configuration for Alerts Management Platform.
1212

1313
## Az.AlertsManagement Cmdlets
14-
### [Measure-AzAlertStatistic](Measure-AzAlertStatistic.md)
15-
Gets the summary of alerts grouped by some properties.
14+
### [Get-AzActionRule](Get-AzActionRule.md)
15+
Get Action Rules Information
1616

1717
### [Get-AzAlert](Get-AzAlert.md)
18-
Gets list of alerts filtered on various parameters.
18+
Get Alerts Information
1919

2020
### [Get-AzAlertObjectHistory](Get-AzAlertObjectHistory.md)
21-
Gets history of alert - keeps track of monitor condition and state modifications.
22-
23-
### [Update-AzAlertState](Update-AzAlertState.md)
24-
Updates the state of alert.
21+
Gets Alert History information
2522

2623
### [Get-AzSmartGroup](Get-AzSmartGroup.md)
27-
Gets list of smart group filtered on various parameters.
24+
Gets Smart Groups information
2825

2926
### [Get-AzSmartGroupHistory](Get-AzSmartGroupHistory.md)
30-
Gets history of smart group - keeps track of monitor condition and state modifications.
27+
Gets smart group history
3128

32-
### [Update-AzSmartGroupState](Update-AzSmartGroupState.md)
33-
Updates the state of smart group.
29+
### [Measure-AzAlertStatistic](Measure-AzAlertStatistic.md)
30+
Gets Alert Summary Information
3431

35-
### [Get-AzActionRule](Get-AzActionRule.md)
36-
Gets list of action rule filtered on various parameters.
32+
### [Remove-AzActionRule](Remove-AzActionRule.md)
33+
Deletes a action group
3734

3835
### [Set-AzActionRule](Set-AzActionRule.md)
39-
Creates or updates action rule.
36+
Create or update an action rule.
4037

4138
### [Update-AzActionRule](Update-AzActionRule.md)
42-
Updates the status and tags associated with action rule.
39+
Updates action rule properties.
40+
41+
### [Update-AzAlertState](Update-AzAlertState.md)
42+
Updates alert state
43+
44+
### [Update-AzSmartGroupState](Update-AzSmartGroupState.md)
45+
Updates smart group state
4346

44-
### [Remove-AzActionRule](Remove-AzActionRule.md)
45-
Deletes action rule.

src/AlertsManagement/AlertsManagement/help/Get-AzActionRule.md

Lines changed: 56 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ Get Action Rules Information
1212

1313
## SYNTAX
1414

15+
### ListActionRules (Default)
16+
```
17+
Get-AzActionRule [-Name <String>] [-ResourceGroupName <String>] [-TargetResourceType <String>]
18+
[-MonitorService <String>] [-Severity <String>] [-ImpactedScope <String>] [-AlertRuleId <String>]
19+
[-Description <String>] [-ActionGroup <String>] [-DefaultProfile <IAzureContextContainer>]
20+
[<CommonParameters>]
21+
```
22+
1523
### ResourceId
1624
```
1725
Get-AzActionRule -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
@@ -23,11 +31,19 @@ Get-AzActionRule -Name <String> -ResourceGroupName <String> [-DefaultProfile <IA
2331
[<CommonParameters>]
2432
```
2533

26-
### ListActionRules
34+
### ListActionRulesByTargetResourceId
2735
```
28-
Get-AzActionRule [-Name <String>] [-ResourceGroupName <String>] [-TargetResource <String>]
29-
[-TargetResourceType <String>] [-TargetResourceGroup <String>] [-MonitorService <String>] [-Severity <String>]
30-
[-ImpactedScope <String>] [-AlertRuleId <String>] [-Description <String>] [-ActionGroup <String>]
36+
Get-AzActionRule [-Name <String>] [-ResourceGroupName <String>] [-TargetResourceId <String>]
37+
[-MonitorService <String>] [-Severity <String>] [-ImpactedScope <String>] [-AlertRuleId <String>]
38+
[-Description <String>] [-ActionGroup <String>] [-DefaultProfile <IAzureContextContainer>]
39+
[<CommonParameters>]
40+
```
41+
42+
### ListActionRulesByTargetResourceGroup
43+
```
44+
Get-AzActionRule [-Name <String>] [-ResourceGroupName <String>] [-TargetResourceType <String>]
45+
[-TargetResourceGroup <String>] [-MonitorService <String>] [-Severity <String>] [-ImpactedScope <String>]
46+
[-AlertRuleId <String>] [-Description <String>] [-ActionGroup <String>]
3147
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
3248
```
3349

@@ -56,8 +72,8 @@ Get the action rule with name Test-Action-Rule in test-rg resource group.
5672
Action group
5773

5874
```yaml
59-
Type: String
60-
Parameter Sets: ListActionRules
75+
Type: System.String
76+
Parameter Sets: ListActionRules, ListActionRulesByTargetResourceId, ListActionRulesByTargetResourceGroup
6177
Aliases:
6278

6379
Required: False
@@ -71,8 +87,8 @@ Accept wildcard characters: False
7187
Filter on Alert Rule Id
7288
7389
```yaml
74-
Type: String
75-
Parameter Sets: ListActionRules
90+
Type: System.String
91+
Parameter Sets: ListActionRules, ListActionRulesByTargetResourceId, ListActionRulesByTargetResourceGroup
7692
Aliases:
7793

7894
Required: False
@@ -86,7 +102,7 @@ Accept wildcard characters: False
86102
The credentials, account, tenant, and subscription used for communication with Azure.
87103
88104
```yaml
89-
Type: IAzureContextContainer
105+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
90106
Parameter Sets: (All)
91107
Aliases: AzContext, AzureRmContext, AzureCredential
92108

@@ -101,8 +117,8 @@ Accept wildcard characters: False
101117
Filter all the alerts having the Smart Group Id
102118
103119
```yaml
104-
Type: String
105-
Parameter Sets: ListActionRules
120+
Type: System.String
121+
Parameter Sets: ListActionRules, ListActionRulesByTargetResourceId, ListActionRulesByTargetResourceGroup
106122
Aliases:
107123

108124
Required: False
@@ -116,8 +132,8 @@ Accept wildcard characters: False
116132
Filter on Impacted scope
117133
118134
```yaml
119-
Type: String
120-
Parameter Sets: ListActionRules
135+
Type: System.String
136+
Parameter Sets: ListActionRules, ListActionRulesByTargetResourceId, ListActionRulesByTargetResourceGroup
121137
Aliases:
122138

123139
Required: False
@@ -131,8 +147,8 @@ Accept wildcard characters: False
131147
Filter on Moniter Service
132148
133149
```yaml
134-
Type: String
135-
Parameter Sets: ListActionRules
150+
Type: System.String
151+
Parameter Sets: ListActionRules, ListActionRulesByTargetResourceId, ListActionRulesByTargetResourceGroup
136152
Aliases:
137153

138154
Required: False
@@ -146,23 +162,23 @@ Accept wildcard characters: False
146162
Name of action rule.
147163
148164
```yaml
149-
Type: String
150-
Parameter Sets: ActionRuleByName
165+
Type: System.String
166+
Parameter Sets: ListActionRules, ListActionRulesByTargetResourceId, ListActionRulesByTargetResourceGroup
151167
Aliases:
152168

153-
Required: True
169+
Required: False
154170
Position: Named
155171
Default value: None
156172
Accept pipeline input: False
157173
Accept wildcard characters: False
158174
```
159175
160176
```yaml
161-
Type: String
162-
Parameter Sets: ListActionRules
177+
Type: System.String
178+
Parameter Sets: ActionRuleByName
163179
Aliases:
164180

165-
Required: False
181+
Required: True
166182
Position: Named
167183
Default value: None
168184
Accept pipeline input: False
@@ -173,23 +189,23 @@ Accept wildcard characters: False
173189
Resource Group Name in which action rule resides.
174190
175191
```yaml
176-
Type: String
177-
Parameter Sets: ActionRuleByName
192+
Type: System.String
193+
Parameter Sets: ListActionRules, ListActionRulesByTargetResourceId, ListActionRulesByTargetResourceGroup
178194
Aliases:
179195

180-
Required: True
196+
Required: False
181197
Position: Named
182198
Default value: None
183199
Accept pipeline input: False
184200
Accept wildcard characters: False
185201
```
186202
187203
```yaml
188-
Type: String
189-
Parameter Sets: ListActionRules
204+
Type: System.String
205+
Parameter Sets: ActionRuleByName
190206
Aliases:
191207

192-
Required: False
208+
Required: True
193209
Position: Named
194210
Default value: None
195211
Accept pipeline input: False
@@ -200,7 +216,7 @@ Accept wildcard characters: False
200216
Get Action rule by resoure id.
201217
202218
```yaml
203-
Type: String
219+
Type: System.String
204220
Parameter Sets: ResourceId
205221
Aliases:
206222

@@ -215,8 +231,8 @@ Accept wildcard characters: False
215231
Filter on Severity of alert
216232
217233
```yaml
218-
Type: String
219-
Parameter Sets: ListActionRules
234+
Type: System.String
235+
Parameter Sets: ListActionRules, ListActionRulesByTargetResourceId, ListActionRulesByTargetResourceGroup
220236
Aliases:
221237

222238
Required: False
@@ -226,12 +242,12 @@ Accept pipeline input: False
226242
Accept wildcard characters: False
227243
```
228244
229-
### -TargetResource
230-
Filter on Resource Id of the target resource of alert.
245+
### -TargetResourceGroup
246+
Filter on Resource group name of the target resource of alert.
231247
232248
```yaml
233-
Type: String
234-
Parameter Sets: ListActionRules
249+
Type: System.String
250+
Parameter Sets: ListActionRulesByTargetResourceGroup
235251
Aliases:
236252

237253
Required: False
@@ -241,12 +257,12 @@ Accept pipeline input: False
241257
Accept wildcard characters: False
242258
```
243259
244-
### -TargetResourceGroup
245-
Filter on Resource group name of the target resource of alert.
260+
### -TargetResourceId
261+
Filter on Resource Id of the target resource of alert.
246262
247263
```yaml
248-
Type: String
249-
Parameter Sets: ListActionRules
264+
Type: System.String
265+
Parameter Sets: ListActionRulesByTargetResourceId
250266
Aliases:
251267

252268
Required: False
@@ -260,8 +276,8 @@ Accept wildcard characters: False
260276
Filter on Resource type of the target resource of alert.
261277
262278
```yaml
263-
Type: String
264-
Parameter Sets: ListActionRules
279+
Type: System.String
280+
Parameter Sets: ListActionRules, ListActionRulesByTargetResourceGroup
265281
Aliases:
266282

267283
Required: False

0 commit comments

Comments
 (0)