Merge pull request #4710 from AuxMon/refreshAfterBuild

[Insights] Adding details to existing deprecation message and fixing help files issues.

Author: cormacpayne

src/ResourceManager/Insights/ChangeLog.md

@@ -18,6 +18,11 @@
         - Additional information about change #1
 -->
 ## Current Release
+    * Add-AzureRmLogAlertRule
+        - Adding details to deprecation warning introduced in April 2017: the cmdlet will stop having effect: its functionality is moved to the "ActivityLogAlerts" cmdlets.
+        - Help file modified to include the deprecation warning and the details.
+    * Disable-AzureRmActivityLogAlert, Disable-AzureRmActivityLogAlert, Remove-AzureRmActivityLogAlert, Set-AzureRmActivityLogAlert
+        - Help file modified: removed text stating that the Force arguments was accepted since that argument is not accepted.
 
 ## Version 3.4.0
     * New cmdlet Disable-AzureRmActivityLogAlert

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

@@ -90,7 +90,8 @@ private RuleCondition CreateRuleCondition()
 
         protected override AlertRuleResource CreateSdkCallParameters()
         {
-            WriteWarning("*** Add-AzureRMLogAlertRule cmdlet will be deprecated in a future release.");
+            WriteWarning("*** This cmdlet will be removed in the 5.0 release (November 2017.)");
+            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.");
 
             RuleCondition condition = this.CreateRuleCondition();
 

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

@@ -106,7 +106,7 @@ private static string ExtractTargetResourceId(AlertRuleResource alertRuleResourc
         /// </summary>
         protected override void ProcessRecordInternal()
         {
-            WriteWarning("The output of this cmdlet will be flattened, i.e. elimination of the properties field, in a future release to improve the user experience.");
+            WriteWarning("Output change: The output of this cmdlet will be flattened, i.e. elimination of the properties field, in the release 5.0.0 - November 2017 to improve the user experience.");
             if (string.IsNullOrWhiteSpace(this.Name))
             {
                 // Retrieve all the AlertRules for a ResourceGroup

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

@@ -49,7 +49,7 @@ public class RemoveAzureRmAlertRuleCommand : ManagementCmdletBase
         /// </summary>
         protected override void ProcessRecordInternal()
         {
-            WriteWarning("The type of the output will change in a future release to become a single object, not a list.");
+            WriteWarning("Output change: The type of the output will change in the release 5.0.0 - November 2017 - to return a single object containing the request Id and the status code.");
             var result = this.MonitorManagementClient.AlertRules.DeleteWithHttpMessagesAsync(resourceGroupName: this.ResourceGroup, ruleName: this.Name).Result;
 
             // Keep this response for backwards compatibility.

src/ResourceManager/Insights/Commands.Insights/Autoscale/GetAzureRmAutoscaleSettingCommand.cs

@@ -59,7 +59,7 @@ public class GetAzureRmAutoscaleSettingCommand : ManagementCmdletBase
         /// </summary>
         protected override void ProcessRecordInternal()
         {
-            WriteWarning("The AutoscaleSettingResourceName field will be deprecated in a future release since it always equals the Name field. In this version is optional.");
+            WriteWarning("Output change: The AutoscaleSettingResourceName field will be deprecated in the release 5.0.0 - November 2017 - since it always equals the Name field.");
             if (string.IsNullOrWhiteSpace(this.Name))
             {
                 // Retrieve all the Autoscale settings for a resource group

src/ResourceManager/Insights/Commands.Insights/LogProfiles/RemoveAzureRmLogProfileCommand.cs

@@ -40,7 +40,7 @@ public class RemoveAzureRmLogProfileCommand : ManagementCmdletBase
 
         protected override void ProcessRecordInternal()
         {
-            WriteWarning("The type of the output will change to return a single object containing the request Id and the status code.");
+            WriteWarning("Output change: The type of the output will change in the release 5.0.0 - November 2017 - to return a single object containing the request Id and the status code.");
             Rest.Azure.AzureOperationResponse result = this.MonitorManagementClient.LogProfiles.DeleteWithHttpMessagesAsync(logProfileName: this.Name, cancellationToken: CancellationToken.None).Result;
 
             /*

src/ResourceManager/Insights/Commands.Insights/LogsCmdletBase.cs

@@ -165,7 +165,7 @@ protected string ProcessParameters()
         {
             string queryFilter = this.ProcessGeneralParameters();
             var result = this.ProcessParticularParameters(queryFilter);
-            WriteWarning("Deprecation: The field EventChannels from the EventData object is being deprecated since it now returns a constant value (Admin,Operation)");
+            WriteWarning("Output change: The field EventChannels from the EventData object is being deprecated in the release 5.0.0 - November 2017 - since it now returns a constant value (Admin,Operation)");
             return result;
         }
 

src/ResourceManager/Insights/Commands.Insights/UsageMetrics/GetAzureRmUsageCommand.cs

@@ -136,7 +136,7 @@ private static IEnumerable<PSUsageMetric> ExtractCollectionFromResult(IEnumerato
         /// </summary>
         protected override void ProcessRecordInternal()
         {
-            WriteWarning("Get-AzureRmUsage will be deprecated in a future release.");
+            WriteWarning("*** This cmdlet will be removed in the 5.0 release (November 2017.)");
 
             var queryFilter = new ODataQuery<UsageMetric>(this.ProcessParameters());
             string apiVersion = this.ApiVersion ?? DefaultApiVersion;

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

@@ -24,6 +24,8 @@ Add-AzureRmLogAlertRule [-TargetResourceGroup <String>] [-TargetResourceId <Stri
 The **Add-AzureRmLogAlertRule** cmdlet adds or replaces an event alert rule.
 The added rule is associated with a resource group and has a name.
 
+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.
+
 ## EXAMPLES
 
 ### Example 1: Add a log alert rule

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

@@ -18,7 +18,7 @@ Disable-AzureRmActivityLogAlert [-InputObject <PSActivityLogAlertResource>] [-Re
 
 ## DESCRIPTION
 The **Disable-AzureRmActivityLogAlert** cmdlet disables and activity log alert and allows setting its tags.
-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.
+This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource.
 
 ## EXAMPLES
 

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

@@ -18,7 +18,7 @@ Enable-AzureRmActivityLogAlert [-InputObject <PSActivityLogAlertResource>] [-Res
 
 ## DESCRIPTION
 The **Enable-AzureRmActivityLogAlert** cmdlet allows enabling an activity log alert and setting its tags.
-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.
+This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource.
 
 ## EXAMPLES
 

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

@@ -28,6 +28,8 @@ PS C:\>$condition = New-AzureRmActivityLogAlertCondition -Field "Requests" -Equa
 
 This command creates a new activity log alert condition object in memory.
 
+**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.)
+
 ## PARAMETERS
 
 ### -Field

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

@@ -18,7 +18,7 @@ Remove-AzureRmActivityLogAlert [-InputObject <PSActivityLogAlertResource>] [-Res
 
 ## DESCRIPTION
 The **Remove-AzureRmActivityLogAlert** cmdlet removes an activity log alert.
-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.
+This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource.
 
 ## EXAMPLES
 

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

@@ -23,7 +23,7 @@ Set-AzureRmActivityLogAlert [-InputObject <PSActivityLogAlertResource> [-Scope <
 ## DESCRIPTION
 The **Set-AzureRmActivityLogAlert** cmdlet creates a new or sets an existing activity log alert.
 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).
-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.
+This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating/modifying the resource.
 
 ## EXAMPLES
 
@@ -147,6 +147,8 @@ Accept wildcard characters: False
 ### -Condition
 The list of conditions for the activity log alert.
 
+**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.
+
 ```yaml
 Type: <System.Collections.Generic.List`1[ActivityLogAlertLeafCondition]>
 Parameter Sets: (All)

src/ResourceManager/Insights/documentation/upcoming-breaking-changes.md

@@ -27,6 +27,32 @@
 
 # Upcoming Breaking Changes
 
+## Release 5.0.0 - November 2017
+
+    The following cmdlets will be deprecated in this release
+
+    **Add-AzureRMLogAlertRule**
+    - 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.
+
+    **Get-AzureRMUsage**
+
+    The following cmdlets will show some potentially breaking change, but will NOT be deprecated
+
+    **Get-AzureRmAlertHistory**
+    **Get-AzureRmAutoscaleHistory**
+    **Get-AzureRmLogs**
+    - Output change: The field EventChannels from the EventData object (returned by these cmdlets) is being deprecated in the release 5.0.0 - November 2017 - since it now returns a constant value (Admin,Operation.)
+
+    **Get-AzureRmAlertRule**
+    - Output change: The output of this cmdlet will be flattened, i.e. elimination of the properties field, to improve the user experience.
+
+    **Get-AzureRmAutoscaleSetting**
+    - Output change: The AutoscaleSettingResourceName field will be deprecated since it always equals the Name field.
+
+    **Remove-AzureRmAlertRule**
+    **Remove-AzureRmLogProfile**
+    - Output change: The type of the output will change to return a single object containing the request Id and the status code.
+
 ## Release 3.0.0
 
     The following cmdlets were affected this release: