Skip to content

Commit 330896d

Browse files
authored
[Az.StorageSync] Remove alias "RegisteredServer" for InputObject parameter of Set-AzStorageSyncServerEndpoint (#21730)
* Remove alias "RegisteredServer" for InputObject parameter of Set-AzStorageSyncServerEndpoint * Update ChangeLog to reflect breaking change in upcoming release * Add exception file BreakingChangeIssues for Az.StorageSync, and revert changes to Az.StorageSync-UpcomingBreakingChanges.md
1 parent 8de2dbb commit 330896d

File tree

4 files changed

+5
-3
lines changed

4 files changed

+5
-3
lines changed

src/StorageSync/StorageSync/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- Additional information about change #1
1919
-->
2020
## Upcoming Release
21+
* Deprecated "RegisteredServer" alias for InputObject parameter for Set-AzStorageSyncServerEndpoint
2122

2223
## Version 1.7.0
2324
* Migrated Azure AD features in Az.StorageSync to MSGraph APIs. The cmdlets will call MSGraph API according to input parameters: New-AzStorageSyncCloudEndpoint

src/StorageSync/StorageSync/ServerEndpoint/SetServerEndpointCommand.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,7 @@ public class SetServerEndpointCommand : StorageSyncClientCmdletBase
117117
Mandatory = true,
118118
ValueFromPipeline = true,
119119
HelpMessage = HelpMessages.ServerEndpointObjectParameter)]
120-
[CmdletParameterBreakingChange("InputObject", ChangeDescription = "Alias RegisteredServer is invalid and preserved for compatibility. Alias ServerEndpoint should be used instead")]
121-
[Alias(StorageSyncAliases.RegisteredServerAlias, StorageSyncAliases.ServerEndpointAlias)]
120+
[Alias(StorageSyncAliases.ServerEndpointAlias)]
122121
public PSServerEndpoint InputObject { get; set; }
123122

124123
/// <summary>

src/StorageSync/StorageSync/help/Set-AzStorageSyncServerEndpoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ SyncGroup Object, normally passed through the parameter.
100100
```yaml
101101
Type: Microsoft.Azure.Commands.StorageSync.Models.PSServerEndpoint
102102
Parameter Sets: ObjectParameterSet
103-
Aliases: RegisteredServer, ServerEndpoint
103+
Aliases: ServerEndpoint
104104

105105
Required: True
106106
Position: 0
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
"Module","ClassName","Target","Severity","ProblemId","Description","Remediation"
2+
"Az.StorageSync","Microsoft.Azure.Commands.StorageSync.Cmdlets.SetServerEndpointCommand","Set-AzStorageSyncServerEndpoint","0","2010","The cmdlet 'Set-AzStorageSyncServerEndpoint' no longer supports the alias 'RegisteredServer' for parameter 'InputObject'.","Add the alias 'RegisteredServer' back to parameter 'InputObject'."

0 commit comments

Comments
 (0)