Skip to content

[Relay] added breaking change. #20930

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
BethanyZhou merged 3 commits into from
Feb 20, 2023
Merged

[Relay] added breaking change. #20930

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c8b77c7
[Relay]add breaking change for cmdlets.
Feb 15, 2023
c85ada0
[Relay]updated changelog.md.
Feb 15, 2023
f87a974
[Relay]add target version for breaking change.
Feb 17, 2023
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
3 changes: 3 additions & 0 deletions src/Relay/Relay/ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
- Additional information about change #1
-->
## Upcoming Release
* Added breaking change message for cmdlets.
* `Set-AzRelayNamespace`
* `Get-AzRelayOperation`

## Version 1.0.3
* Update references in .psd1 to use relative path
Expand Down
2 changes: 2 additions & 0 deletions src/Relay/Relay/Cmdlets/Namespace/SetAzureRelayNamespace.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
using Microsoft.Azure.Commands.Relay.Models;
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
using Microsoft.Azure.Commands.ResourceManager.Common.Tags;
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
using System.Collections;
using System.Collections.Generic;
using System.Management.Automation;
Expand All @@ -23,6 +24,7 @@ namespace Microsoft.Azure.Commands.Relay.Commands.Namespace
/// <summary>
/// 'Set-AzRelayNamespace' Cmdlet updates the specified Relay Namespace
/// </summary>
[GenericBreakingChange("Set-AzRelayNamespace will be removed in an upcoming breaking change release, you can use Update-AzRelayNamespace in a future release")]

@BethanyZhou BethanyZhou Feb 17, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a target date or target version in breaking change message.

@LucasYao93 LucasYao93 Feb 17, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

[Cmdlet("Set", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "RelayNamespace", SupportsShouldProcess = true), OutputType(typeof(PSRelayNamespaceAttributes))]
public class SetAzureRelayNamespace : AzureRelayCmdletBase
{
Expand Down
2 changes: 2 additions & 0 deletions src/Relay/Relay/Cmdlets/Operations/GetAzureRelayOperations.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,14 @@
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;

namespace Microsoft.Azure.Commands.Relay.Commands.Namespace
{
/// <summary>
/// 'Get-AzRelayOperation' Cmdlet retrive the Operations List
/// </summary>
[GenericBreakingChange("Get-AzRelayOperation will be removed in an upcoming breaking change release. Please use 'Get-AzProviderOperation Microsoft.Relay/*'")]
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "RelayOperation"), OutputType(typeof(PSOperationAttributes))]
public class GetAzureRmRelayOperation : AzureRelayCmdletBase
{
Expand Down