Skip to content

[APIM]add warning for upcoming breaking change #17055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 31, 2022
Merged

[APIM]add warning for upcoming breaking change #17055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
48c4c24
msg
KacieKK Feb 9, 2022
69e117e
warning
KacieKK Mar 22, 2022
f31fff5
add using
KacieKK Mar 25, 2022
6ed3805
change desc
KacieKK Mar 25, 2022
fa929a1
alias
KacieKK Mar 29, 2022
b865375
order
KacieKK Mar 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/ApiManagement/ApiManagement.ServiceManagement/Commands/NewAzureApiManagementOperation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
using System;
using System.Management.Automation;
using Management.ApiManagement.Models;
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;

[Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementOperation")]
[OutputType(typeof(PsApiManagementOperation))]
Expand Down Expand Up @@ -88,12 +89,16 @@ public class NewAzureApiManagementOperation : AzureApiManagementCmdletBase
" Use the parameter to give more details on parameters like description, type, possible values.")]
public PsApiManagementParameter[] TemplateParameters { get; set; }

public const String ChangeDesc = "Change Request.Representations.Sample to Request.Representations.Example";
[CmdletParameterBreakingChange("Request.Representations.Sample", ChangeDescription = ChangeDesc)]
[Parameter(
ValueFromPipelineByPropertyName = true,
Mandatory = false,
HelpMessage = "Operation request details. This parameter is optional.")]
public PsApiManagementRequest Request { get; set; }

public const String ChangeDesc2 = "Change Responses.Representations.Sample to Responses.Representations.Example";
[CmdletParameterBreakingChange("Responses.Representations.Sample", ChangeDescription = ChangeDesc2)]
[Parameter(
ValueFromPipelineByPropertyName = true,
Mandatory = false,
Expand Down
7 changes: 6 additions & 1 deletion src/ApiManagement/ApiManagement.ServiceManagement/Commands/SetAzureApiManagementOperation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
using Management.ApiManagement.Models;
using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models;
using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Properties;
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;

[Cmdlet("Set", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementOperation", SupportsShouldProcess = true)]
[OutputType(typeof(PsApiManagementOperation))]
Expand Down Expand Up @@ -88,12 +89,16 @@ public class SetAzureApiManagementOperation : AzureApiManagementCmdletBase
" Use the parameter to give more details on parameters like description, type, possible values.")]
public PsApiManagementParameter[] TemplateParameters { get; set; }

public const String ChangeDesc = "Change Request.Representations.Sample Request.Representations.Example";
[CmdletParameterBreakingChange("Request", ChangeDescription = ChangeDesc)]
[Parameter(
ValueFromPipelineByPropertyName = true,
Mandatory = false,
HelpMessage = "Operation request details. This parameter is optional.")]
public PsApiManagementRequest Request { get; set; }


public const String ChangeDesc2 = "Change Responses.Representations.Sample to Responses.Representations.Example";
[CmdletParameterBreakingChange("Responses", ChangeDescription = ChangeDesc2)]
[Parameter(
ValueFromPipelineByPropertyName = true,
Mandatory = false,
Expand Down
1 change: 1 addition & 0 deletions src/ApiManagement/ApiManagement/ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
- Additional information about change #1
-->
## Upcoming Release
Added warning message for upcoming breaking change.

## Version 2.3.1
* Fixed a bug in `Get-AzApiManagementTenantGitAccess` cmdlet.
Expand Down
9 changes: 8 additions & 1 deletion src/ApiManagement/documentation/upcoming-breaking-changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,11 @@
https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md
-->

# Upcoming Breaking Changes
# Upcoming Breaking Changes

The following cmdlets were affected this release:

**Set-AzApiManagementOperation**
**New-AzApiManagementOperation**

BreakingChangeAttributeParameterReplaced: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRepresentation.Samlple