Skip to content

Commit 3afca11

Browse files
committed
[Insights] Adding details to existing deprecation message and fixing help files issues.
1 parent f34c546 commit 3afca11

8 files changed

+16
-4
lines changed

src/ResourceManager/Insights/ChangeLog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@
1818
- Additional information about change #1
1919
-->
2020
## Current Release
21+
* Add-AzureRmLogAlertRule
22+
- Adding details to deprecation warning introduced in April 2017: the cmdlet will stop having effect: its functionality is moved to the "ActivityLogAlerts" cmdlets.
23+
- Help file modified to include the deprecation warning and the details.
24+
* Disable-AzureRmActivityLogAlert, Disable-AzureRmActivityLogAlert, Remove-AzureRmActivityLogAlert, Set-AzureRmActivityLogAlert
25+
- Help file modified: removed text stating that the Force arguments was accepted since that argument is not accepted.
2126

2227
## Version 3.4.0
2328
* New cmdlet Disable-AzureRmActivityLogAlert

src/ResourceManager/Insights/Commands.Insights/Alerts/AddAzureRmLogAlertRuleCommand.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ private RuleCondition CreateRuleCondition()
9191
protected override AlertRuleResource CreateSdkCallParameters()
9292
{
9393
WriteWarning("*** Add-AzureRMLogAlertRule cmdlet will be deprecated in a future release.");
94+
WriteWarning("*** Note: After October 1st using this cmdlet will no longer have any effect as this functionality is being transitioned to Activity Log Alerts. Please see https://aka.ms/migratemealerts for more information.");
9495

9596
RuleCondition condition = this.CreateRuleCondition();
9697

src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmLogAlertRule.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ Add-AzureRmLogAlertRule [-TargetResourceGroup <String>] [-TargetResourceId <Stri
2424
The **Add-AzureRmLogAlertRule** cmdlet adds or replaces an event alert rule.
2525
The added rule is associated with a resource group and has a name.
2626

27+
As announced in previous releases: **Add-AzureRMLogAlertRule cmdlet will be deprecated in a future release.** After October 1st 2017 using this cmdlet will no longer have any effect as this functionality is being transitioned to Activity Log Alerts. Please see **_https://aka.ms/migratemealerts_** for more information.
28+
2729
## EXAMPLES
2830

2931
### Example 1: Add a log alert rule

src/ResourceManager/Insights/Commands.Insights/help/Disable-AzureRmActivityLogAlert.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Disable-AzureRmActivityLogAlert [-InputObject <PSActivityLogAlertResource>] [-Re
1818

1919
## DESCRIPTION
2020
The **Disable-AzureRmActivityLogAlert** cmdlet disables and activity log alert and allows setting its tags.
21-
This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource and it accepts the -Force argument.
21+
This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource.
2222

2323
## EXAMPLES
2424

src/ResourceManager/Insights/Commands.Insights/help/Enable-AzureRmActivityLogAlert.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Enable-AzureRmActivityLogAlert [-InputObject <PSActivityLogAlertResource>] [-Res
1818

1919
## DESCRIPTION
2020
The **Enable-AzureRmActivityLogAlert** cmdlet allows enabling an activity log alert and setting its tags.
21-
This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource and it accepts the -Force argument.
21+
This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource.
2222

2323
## EXAMPLES
2424

src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActivityLogAlertCondition.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ PS C:\>$condition = New-AzureRmActivityLogAlertCondition -Field "Requests" -Equa
2828

2929
This command creates a new activity log alert condition object in memory.
3030

31+
**NOTE**: when this cmdlet is used with Set-AzureRmActivityLogAlert at least one of these objects, passed as parameters, must have its Field equal to "Category". Otherwise, the backend responds with a 400 (BadRequest.)
32+
3133
## PARAMETERS
3234

3335
### -Field

src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmActivityLogAlert.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Remove-AzureRmActivityLogAlert [-InputObject <PSActivityLogAlertResource>] [-Res
1818

1919
## DESCRIPTION
2020
The **Remove-AzureRmActivityLogAlert** cmdlet removes an activity log alert.
21-
This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource and it accepts the -Force argument.
21+
This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource.
2222

2323
## EXAMPLES
2424

src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmActivityLogAlert.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Set-AzureRmActivityLogAlert [-InputObject <PSActivityLogAlertResource> [-Scope <
2323
## DESCRIPTION
2424
The **Set-AzureRmActivityLogAlert** cmdlet creates a new or sets an existing activity log alert.
2525
For tags, conditions, and actions the objects must be created in advance and passed as parameters in this call as a comma separated (see the example below).
26-
This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating/modifying the resource and it accepts the -Force argument.
26+
This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating/modifying the resource.
2727

2828
## EXAMPLES
2929

@@ -147,6 +147,8 @@ Accept wildcard characters: False
147147
### -Condition
148148
The list of conditions for the activity log alert.
149149
150+
**NOTE**: In the list of conditions there must be at least one with the Field equal to "Category". The backend responds with 400 (BadRequest) if this condition is not present.
151+
150152
```yaml
151153
Type: <System.Collections.Generic.List`1[ActivityLogAlertLeafCondition]>
152154
Parameter Sets: (All)

0 commit comments

Comments
 (0)