Skip to content

Commit bfe873a

Browse files
committed
[Insights] Adding details to the deprecation / breaking-changes documentation.
1 parent 3afca11 commit bfe873a

File tree

8 files changed

+33
-7
lines changed

8 files changed

+33
-7
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ private RuleCondition CreateRuleCondition()
9090

9191
protected override AlertRuleResource CreateSdkCallParameters()
9292
{
93-
WriteWarning("*** Add-AzureRMLogAlertRule cmdlet will be deprecated in a future release.");
93+
WriteWarning("*** This cmdlet will be removed in the 5.0 release (November 2017.)");
9494
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.");
9595

9696
RuleCondition condition = this.CreateRuleCondition();

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ private static string ExtractTargetResourceId(AlertRuleResource alertRuleResourc
106106
/// </summary>
107107
protected override void ProcessRecordInternal()
108108
{
109-
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.");
109+
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.");
110110
if (string.IsNullOrWhiteSpace(this.Name))
111111
{
112112
// Retrieve all the AlertRules for a ResourceGroup

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public class RemoveAzureRmAlertRuleCommand : ManagementCmdletBase
4949
/// </summary>
5050
protected override void ProcessRecordInternal()
5151
{
52-
WriteWarning("The type of the output will change in a future release to become a single object, not a list.");
52+
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.");
5353
var result = this.MonitorManagementClient.AlertRules.DeleteWithHttpMessagesAsync(resourceGroupName: this.ResourceGroup, ruleName: this.Name).Result;
5454

5555
// Keep this response for backwards compatibility.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public class GetAzureRmAutoscaleSettingCommand : ManagementCmdletBase
5959
/// </summary>
6060
protected override void ProcessRecordInternal()
6161
{
62-
WriteWarning("The AutoscaleSettingResourceName field will be deprecated in a future release since it always equals the Name field. In this version is optional.");
62+
WriteWarning("Output change: The AutoscaleSettingResourceName field will be deprecated in the release 5.0.0 - November 2017 - since it always equals the Name field.");
6363
if (string.IsNullOrWhiteSpace(this.Name))
6464
{
6565
// Retrieve all the Autoscale settings for a resource group

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public class RemoveAzureRmLogProfileCommand : ManagementCmdletBase
4040

4141
protected override void ProcessRecordInternal()
4242
{
43-
WriteWarning("The type of the output will change to return a single object containing the request Id and the status code.");
43+
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.");
4444
Rest.Azure.AzureOperationResponse result = this.MonitorManagementClient.LogProfiles.DeleteWithHttpMessagesAsync(logProfileName: this.Name, cancellationToken: CancellationToken.None).Result;
4545

4646
/*

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ protected string ProcessParameters()
165165
{
166166
string queryFilter = this.ProcessGeneralParameters();
167167
var result = this.ProcessParticularParameters(queryFilter);
168-
WriteWarning("Deprecation: The field EventChannels from the EventData object is being deprecated since it now returns a constant value (Admin,Operation)");
168+
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)");
169169
return result;
170170
}
171171

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ private static IEnumerable<PSUsageMetric> ExtractCollectionFromResult(IEnumerato
136136
/// </summary>
137137
protected override void ProcessRecordInternal()
138138
{
139-
WriteWarning("Get-AzureRmUsage will be deprecated in a future release.");
139+
WriteWarning("*** This cmdlet will be removed in the 5.0 release (November 2017.)");
140140

141141
var queryFilter = new ODataQuery<UsageMetric>(this.ProcessParameters());
142142
string apiVersion = this.ApiVersion ?? DefaultApiVersion;

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,32 @@
2727

2828
# Upcoming Breaking Changes
2929

30+
## Release 5.0.0 - November 2017
31+
32+
The following cmdlets will be deprecated in this release
33+
34+
**Add-AzureRMLogAlertRule**
35+
- 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.
36+
37+
**Get-AzureRMUsage**
38+
39+
The following cmdlets will show some potentially breaking change, but will NOT be deprecated
40+
41+
**Get-AzureRmAlertHistory**
42+
**Get-AzureRmAutoscaleHistory**
43+
**Get-AzureRmLogs**
44+
- 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.)
45+
46+
**Get-AzureRmAlertRule**
47+
- Output change: The output of this cmdlet will be flattened, i.e. elimination of the properties field, to improve the user experience.
48+
49+
**Get-AzureRmAutoscaleSetting**
50+
- Output change: The AutoscaleSettingResourceName field will be deprecated since it always equals the Name field.
51+
52+
**Remove-AzureRmAlertRule**
53+
**Remove-AzureRmLogProfile**
54+
- Output change: The type of the output will change to return a single object containing the request Id and the status code.
55+
3056
## Release 3.0.0
3157

3258
The following cmdlets were affected this release:

0 commit comments

Comments
 (0)