Skip to content

Commit e98c4ee

Browse files
committed
hide Update variant to customize
1 parent 83763b6 commit e98c4ee

11 files changed

+154
-285
lines changed

src/SecurityInsights/SecurityInsights.Autorest/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,9 +197,14 @@ directive:
197197
subject: ^AlertRule$|^DataConnector$|^EntityQuery$
198198
variant: Create
199199
hide: true
200+
- where:
201+
verb: Update
202+
subject: ^AlertRule$|^DataConnector$|^EntityQuery$
203+
variant: Update
204+
hide: true
200205
- where:
201206
subject: ^AlertRule$|^DataConnector$|^EntityQuery$
202-
variant: ^(Create|Update)(?=.*?(Expanded|JsonFilePath|JsonString))|^CreateViaIdentity$|^CreateViaIdentityWorkspace$
207+
variant: ^(Create|Update)(?=.*?(Expanded|JsonFilePath|JsonString))|^CreateViaIdentity$|^CreateViaIdentityWorkspace$|^UpdateViaIdentity$
203208
remove: true
204209
- where:
205210
verb: ^Update$|^Remove$

src/SecurityInsights/SecurityInsights.Autorest/docs/Az.SecurityInsights.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Delete Sentinel onboarding state
165165
Get requirements state for a data connector type.
166166

167167
### [Update-AzSentinelAlertRule](Update-AzSentinelAlertRule.md)
168-
Update the alert rule.
168+
Updates the alert rule.
169169

170170
### [Update-AzSentinelAlertRuleAction](Update-AzSentinelAlertRuleAction.md)
171171
Update the action of alert rule.
@@ -180,7 +180,7 @@ Update the bookmark.
180180
Update the bookmark relation.
181181

182182
### [Update-AzSentinelDataConnector](Update-AzSentinelDataConnector.md)
183-
Update the data connector.
183+
Updates the data connector.
184184

185185
### [Update-AzSentinelEntityQuery](Update-AzSentinelEntityQuery.md)
186186
Updates the entity query.

src/SecurityInsights/SecurityInsights.Autorest/docs/Update-AzSentinelAlertRule.md

Lines changed: 20 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
external help file:
33
Module Name: Az.SecurityInsights
4-
online version: https://learn.microsoft.com/powershell/module/az.securityinsights/update-azsentinelalertrule
4+
online version: https://learn.microsoft.com/powershell/module/az.securityinsights/Update-azsentinelalertrule
55
schema: 2.0.0
66
---
77

88
# Update-AzSentinelAlertRule
99

1010
## SYNOPSIS
11-
Update the alert rule.
11+
Updates the alert rule.
1212

1313
## SYNTAX
1414

@@ -27,13 +27,6 @@ Update-AzSentinelAlertRule -ResourceGroupName <String> -RuleId <String> -Workspa
2727
[<CommonParameters>]
2828
```
2929

30-
### Update
31-
```
32-
Update-AzSentinelAlertRule -ResourceGroupName <String> -RuleId <String> -WorkspaceName <String>
33-
-AlertRule <IAlertRule> [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf]
34-
[<CommonParameters>]
35-
```
36-
3730
### UpdateFusionMLTI
3831
```
3932
Update-AzSentinelAlertRule -ResourceGroupName <String> -RuleId <String> -WorkspaceName <String> -FusionMLorTI
@@ -63,12 +56,6 @@ Update-AzSentinelAlertRule -ResourceGroupName <String> -RuleId <String> -Workspa
6356
[-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>]
6457
```
6558

66-
### UpdateViaIdentity
67-
```
68-
Update-AzSentinelAlertRule -InputObject <ISecurityInsightsIdentity> -AlertRule <IAlertRule>
69-
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
70-
```
71-
7259
### UpdateViaIdentityFusionMLTI
7360
```
7461
Update-AzSentinelAlertRule -InputObject <ISecurityInsightsIdentity> -FusionMLorTI
@@ -111,7 +98,7 @@ Update-AzSentinelAlertRule -InputObject <ISecurityInsightsIdentity> -Scheduled
11198
```
11299

113100
## DESCRIPTION
114-
Update the alert rule.
101+
Updates the alert rule.
115102

116103
## EXAMPLES
117104

@@ -154,27 +141,12 @@ Accept pipeline input: False
154141
Accept wildcard characters: False
155142
```
156143
157-
### -AlertRule
158-
Alert rule.
159-
160-
```yaml
161-
Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.IAlertRule
162-
Parameter Sets: Update, UpdateViaIdentity
163-
Aliases:
164-
165-
Required: True
166-
Position: Named
167-
Default value: None
168-
Accept pipeline input: True (ByValue)
169-
Accept wildcard characters: False
170-
```
171-
172144
### -AlertRuleTemplateName
173145
174146
175147
```yaml
176148
Type: System.String
177-
Parameter Sets: UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled, UpdateViaIdentityFusionMLTI, UpdateViaIdentityMicrosoftSecurityIncidentCreation, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled
149+
Parameter Sets: (All)
178150
Aliases:
179151

180152
Required: False
@@ -219,7 +191,7 @@ Run the command as a job
219191
220192
```yaml
221193
Type: System.Management.Automation.SwitchParameter
222-
Parameter Sets: UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled, UpdateViaIdentityFusionMLTI, UpdateViaIdentityMicrosoftSecurityIncidentCreation, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled
194+
Parameter Sets: (All)
223195
Aliases:
224196

225197
Required: False
@@ -245,8 +217,7 @@ Accept wildcard characters: False
245217
```
246218
247219
### -DefaultProfile
248-
The DefaultProfile parameter is not functional.
249-
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
220+
The credentials, account, tenant, and subscription used for communication with Azure.
250221
251222
```yaml
252223
Type: System.Management.Automation.PSObject
@@ -280,7 +251,7 @@ Accept wildcard characters: False
280251
281252
```yaml
282253
Type: System.Management.Automation.SwitchParameter
283-
Parameter Sets: UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled, UpdateViaIdentityFusionMLTI, UpdateViaIdentityMicrosoftSecurityIncidentCreation, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled
254+
Parameter Sets: (All)
284255
Aliases:
285256

286257
Required: False
@@ -340,7 +311,7 @@ Accept wildcard characters: False
340311
341312
```yaml
342313
Type: System.Management.Automation.SwitchParameter
343-
Parameter Sets: UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled, UpdateViaIdentityFusionMLTI, UpdateViaIdentityMicrosoftSecurityIncidentCreation, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled
314+
Parameter Sets: (All)
344315
Aliases:
345316

346317
Required: False
@@ -457,10 +428,11 @@ Accept wildcard characters: False
457428
458429
### -InputObject
459430
Identity Parameter
431+
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
460432
461433
```yaml
462434
Type: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity
463-
Parameter Sets: UpdateViaIdentity, UpdateViaIdentityFusionMLTI, UpdateViaIdentityMicrosoftSecurityIncidentCreation, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled
435+
Parameter Sets: UpdateViaIdentityFusionMLTI, UpdateViaIdentityMicrosoftSecurityIncidentCreation, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled
464436
Aliases:
465437

466438
Required: True
@@ -520,7 +492,7 @@ Run the command asynchronously
520492
521493
```yaml
522494
Type: System.Management.Automation.SwitchParameter
523-
Parameter Sets: UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled, UpdateViaIdentityFusionMLTI, UpdateViaIdentityMicrosoftSecurityIncidentCreation, UpdateViaIdentityNRT, UpdateViaIdentityUpdateScheduled
495+
Parameter Sets: (All)
524496
Aliases:
525497

526498
Required: False
@@ -621,12 +593,11 @@ Accept wildcard characters: False
621593
```
622594
623595
### -ResourceGroupName
624-
The name of the resource group.
625-
The name is case insensitive.
596+
The Resource Group Name.
626597
627598
```yaml
628599
Type: System.String
629-
Parameter Sets: Update, UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled
600+
Parameter Sets: UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled
630601
Aliases:
631602

632603
Required: True
@@ -637,11 +608,12 @@ Accept wildcard characters: False
637608
```
638609
639610
### -RuleId
640-
Alert rule ID
611+
[Alias('RuleId')]
612+
The name of Operational Insights Resource Provider.
641613
642614
```yaml
643615
Type: System.String
644-
Parameter Sets: Update, UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled
616+
Parameter Sets: UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled
645617
Aliases:
646618

647619
Required: True
@@ -697,11 +669,12 @@ Accept wildcard characters: False
697669
```
698670
699671
### -SubscriptionId
700-
The ID of the target subscription.
672+
Gets subscription credentials which uniquely identify Microsoft Azure subscription.
673+
The subscription ID forms part of the URI for every service call.
701674
702675
```yaml
703676
Type: System.String
704-
Parameter Sets: Update, UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled
677+
Parameter Sets: UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled
705678
Aliases:
706679

707680
Required: False
@@ -791,7 +764,7 @@ The name of the workspace.
791764
792765
```yaml
793766
Type: System.String
794-
Parameter Sets: Update, UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled
767+
Parameter Sets: UpdateFusionMLTI, UpdateMicrosoftSecurityIncidentCreation, UpdateNRT, UpdateScheduled
795768
Aliases:
796769

797770
Required: True
@@ -837,16 +810,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
837810
838811
## INPUTS
839812
840-
### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.IAlertRule
841-
842813
### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.ISecurityInsightsIdentity
843814
844815
## OUTPUTS
845816
846817
### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.AlertRule
847818
848-
### Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.IAlertRule
849-
850819
## NOTES
851820
852821
## RELATED LINKS

0 commit comments

Comments
 (0)