Remove parameter "-RemoveExisting" from Add-AzureAD- and M365Group-Members and -Owners (#5153)

* remove deprecated parameter from functions

* update documentation

* add line in changelog

---------

Co-authored-by: Gautam Sheth <[email protected]>

Author: svenboll

CHANGELOG.md

@@ -54,6 +54,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Fix `Register-PnPEntraIdApp` Allow to use CER file instead of PFX [#5129](https://github.com/pnp/powershell/issues/5129)
 
 ### Removed
+- Removed `-RemoveExisting` parameter from `Add-PnPAzureADGroupMember`, `Add-PnPAzureADGroupOwner`, `Add-PnPMicrosoft365GroupMember` and `Add-PnPMicrosoft365GroupOwner` cmdlets. It was never really implemented and without function. [#5153](https://github.com/pnp/powershell/pull/5153)
 
 ### Contributors
 
@@ -72,6 +73,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Ali Robertson [alirobe]
 - Christian Veenhuis [ChVeen]
 - James Epp [jamesaepp]
+- Sven Boll [svenboll]
 
 ## [3.1.0]
 

documentation/Add-PnPAzureADGroupMember.md

@@ -20,12 +20,12 @@ Adds members to a particular Azure Active Directory Group. This can be a securit
 ## SYNTAX
 
 ```powershell
-Add-PnPAzureADGroupMember -Identity <AzureADGroupPipeBind> -Users <String[]> [-RemoveExisting] [-Connection <PnPConnection>]
+Add-PnPAzureADGroupMember -Identity <AzureADGroupPipeBind> -Users <String[]> [-Connection <PnPConnection>]
 ```
 
 ## DESCRIPTION
 
-Allows to add users to Azure Active Directory Group. This can be a security, distribution or Microsoft 365 group. By specifying `-RemoveExisting` option it is possible to first clear the group of all existing members.
+Allows to add users to Azure Active Directory Group. This can be a security, distribution or Microsoft 365 group.
 
 ## EXAMPLES
 
@@ -38,13 +38,6 @@ Adds the provided two users as additional members to the Azure Active Directory
 
 ### EXAMPLE 2
 ```powershell
-Add-PnPAzureADGroupMember -Identity "Project Team" -Users "[email protected]","[email protected]" -RemoveExisting
-```
-
-Sets the provided two users as the only members of the Azure Active Directory group named "Project Team" by removing any current existing members first.
-
-### EXAMPLE 3
-```powershell
 Add-PnPAzureADGroupMember -Identity "Project Team" -Users "125eaa87-7b54-41fd-b30f-2adfa68c4afe"
 ```
 
@@ -79,20 +72,6 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
-### -RemoveExisting
-If provided, all existing members will be removed and only those provided through Users will become members.
-
-```yaml
-Type: SwitchParameter
-Parameter Sets: (All)
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -Users
 The UPN(s) of the user(s) to add to the Azure Active Directory group as a member.
 

documentation/Add-PnPAzureADGroupOwner.md

@@ -20,12 +20,12 @@ Adds users to the owners of an Azure Active Directory group. This can be a secur
 ## SYNTAX
 
 ```powershell
-Add-PnPAzureADGroupOwner -Identity <AzureADGroupPipeBind> -Users <String[]> [-RemoveExisting] [-Connection <PnPConnection>]
+Add-PnPAzureADGroupOwner -Identity <AzureADGroupPipeBind> -Users <String[]> [-Connection <PnPConnection>]
 ```
 
 ## DESCRIPTION
 
-Allows to add users to owners of an Azure Active Directory Group. This can be a security, distribution or Microsoft 365 group. By specifying `-RemoveExisting` option it is possible to first clear the group of all existing members.
+Allows to add users to owners of an Azure Active Directory Group. This can be a security, distribution or Microsoft 365 group.
 
 ## EXAMPLES
 
@@ -38,13 +38,6 @@ Adds the provided two users as additional owners to the Azure Active Directory g
 
 ### EXAMPLE 2
 ```powershell
-Add-PnPAzureADGroupOwner -Identity "Project Team" -Users "[email protected]","[email protected]" -RemoveExisting
-```
-
-Sets the provided two users as the only owners of the Azure Active Directory group named "Project Team" by removing any current existing members first.
-
-### EXAMPLE 3
-```powershell
 Add-PnPAzureADGroupOwner -Identity "Project Team" -Users "125eaa87-7b54-41fd-b30f-2adfa68c4afe"
 ```
 
@@ -79,20 +72,6 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
-### -RemoveExisting
-If provided, all existing members will be removed and only those provided through Users will become members.
-
-```yaml
-Type: SwitchParameter
-Parameter Sets: (All)
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -Users
 The UPN(s) of the user(s) to add to the Azure Active Directory group as a member.
 

documentation/Add-PnPMicrosoft365GroupMember.md

@@ -20,7 +20,7 @@ Adds members to a particular Microsoft 365 Group.
 ## SYNTAX
 
 ```powershell
-Add-PnPMicrosoft365GroupMember -Identity <Microsoft365GroupPipeBind> -Users <String[]> [-RemoveExisting] [-Connection <PnPConnection>]
+Add-PnPMicrosoft365GroupMember -Identity <Microsoft365GroupPipeBind> -Users <String[]> [-Connection <PnPConnection>]
 ```
 
 ## DESCRIPTION
@@ -36,13 +36,6 @@ Add-PnPMicrosoft365GroupMember -Identity "Project Team" -Users "[email protected]
 
 Adds the provided two users as additional members to the Microsoft 365 Group named "Project Team".
 
-### EXAMPLE 2
-```powershell
-Add-PnPMicrosoft365GroupMember -Identity "Project Team" -Users "[email protected]","[email protected]" -RemoveExisting
-```
-
-Sets the provided two users as the only members of the Microsoft 365 Group named "Project Team" by removing any current existing members first.
-
 ## PARAMETERS
 
 ### -Connection
@@ -73,20 +66,6 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
-### -RemoveExisting
-If provided, all existing members will be removed and only those provided through Users will become members.
-
-```yaml
-Type: SwitchParameter
-Parameter Sets: (All)
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -Users
 The UPN(s) of the user(s) to add to the Microsoft 365 Group as a member.
 

documentation/Add-PnPMicrosoft365GroupOwner.md

@@ -20,7 +20,7 @@ Adds users to a Microsoft 365 Group as Owners.
 ## SYNTAX
 
 ```powershell
-Add-PnPMicrosoft365GroupOwner -Identity <Microsoft365GroupPipeBind> -Users <String[]> [-RemoveExisting] [-Connection <PnPConnection>] 
+Add-PnPMicrosoft365GroupOwner -Identity <Microsoft365GroupPipeBind> -Users <String[]> [-Connection <PnPConnection>] 
 ```
 
 ## DESCRIPTION
@@ -36,13 +36,6 @@ Add-PnPMicrosoft365GroupOwner -Identity "Project Team" -Users "[email protected]
 
 Adds the provided two users as additional owners to the Microsoft 365 Group named "Project Team".
 
-### EXAMPLE 2
-```powershell
-Add-PnPMicrosoft365GroupOwner -Identity "Project Team" -Users "[email protected]","[email protected]" -RemoveExisting
-```
-
-Sets the provided two users as the only owners of the Microsoft 365 Group named "Project Team" by removing any current existing members first.
-
 ## PARAMETERS
 
 ### -Connection
@@ -73,20 +66,6 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
-### -RemoveExisting
-If provided, all existing owners will be removed and only those provided through Users parameter will become owners.
-
-```yaml
-Type: SwitchParameter
-Parameter Sets: (All)
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -Users
 The UPN(s) of the user(s) to add to the Microsoft 365 Group as an owner.
 

src/Commands/AzureAD/AddAzureADGroupMember.cs

@@ -20,6 +20,7 @@ public class AddAzureADGroupMember : PnPGraphCmdlet
         [Parameter(Mandatory = true)]
         public string[] Users;
 
+        [Obsolete("The parameter is obsolete and will be removed in future versions. You can use Clear-PnPAzureADGroupMember instead.")]
         [Parameter(Mandatory = false)]
         public SwitchParameter RemoveExisting;
 
@@ -39,14 +40,14 @@ protected override void ExecuteCmdlet()
 
                 if (userArray.Length > 0)
                 {
-                    Microsoft365GroupsUtility.AddMembers(GraphRequestHelper, new Guid(group.Id), userArray, RemoveExisting.ToBool());
+                    Microsoft365GroupsUtility.AddMembers(GraphRequestHelper, new Guid(group.Id), userArray);
                 }
 
                 var secGroups = Users.Where(x => Guid.TryParse(x, out emptyGuid)).Select(x => emptyGuid).ToArray();
 
                 if (secGroups.Length > 0)
                 {
-                    Microsoft365GroupsUtility.AddDirectoryMembers(GraphRequestHelper, new Guid(group.Id), secGroups, RemoveExisting.ToBool());
+                    Microsoft365GroupsUtility.AddDirectoryMembers(GraphRequestHelper, new Guid(group.Id), secGroups);
                 }
             }
         }

src/Commands/AzureAD/AddAzureADGroupOwner.cs

@@ -20,6 +20,7 @@ public class AddAzureAdGroupOwner : PnPGraphCmdlet
         [Parameter(Mandatory = true)]
         public string[] Users;
 
+        [Obsolete("The parameter is obsolete and will be removed in future versions. You can use Clear-PnPAzureADGroupOwner instead.")]
         [Parameter(Mandatory = false)]
         public SwitchParameter RemoveExisting;
 
@@ -41,14 +42,14 @@ protected override void ExecuteCmdlet()
 
                 if (userArray.Length > 0)
                 {
-                    Microsoft365GroupsUtility.AddOwners(GraphRequestHelper, new System.Guid(group.Id), userArray, RemoveExisting.ToBool());
+                    Microsoft365GroupsUtility.AddOwners(GraphRequestHelper, new System.Guid(group.Id), userArray);
                 }
 
                 var secGroups = Users.Where(x => Guid.TryParse(x, out emptyGuid)).Select(x => emptyGuid).ToArray();
 
                 if (secGroups.Length > 0)
                 {
-                    Microsoft365GroupsUtility.AddDirectoryOwners(GraphRequestHelper, new System.Guid(group.Id), secGroups, RemoveExisting.ToBool());
+                    Microsoft365GroupsUtility.AddDirectoryOwners(GraphRequestHelper, new System.Guid(group.Id), secGroups);
                 }
             }
         }

src/Commands/Microsoft365Groups/AddMicrosoft365GroupMember.cs

@@ -2,6 +2,7 @@
 using PnP.PowerShell.Commands.Base;
 using PnP.PowerShell.Commands.Base.PipeBinds;
 using PnP.PowerShell.Commands.Utilities;
+using System;
 using System.Management.Automation;
 
 namespace PnP.PowerShell.Commands.Microsoft365Groups
@@ -16,12 +17,13 @@ public class AddMicrosoft365GroupMember : PnPGraphCmdlet
         [Parameter(Mandatory = true)]
         public string[] Users;
 
+        [Obsolete("The parameter is obsolete and will be removed in future versions. You can use Clear-PnPMicrosoft365GroupMember instead.")]
         [Parameter(Mandatory = false)]
         public SwitchParameter RemoveExisting;
 
         protected override void ExecuteCmdlet()
         {
-            Microsoft365GroupsUtility.AddMembers(GraphRequestHelper, Identity.GetGroupId(GraphRequestHelper), Users, RemoveExisting);
+            Microsoft365GroupsUtility.AddMembers(GraphRequestHelper, Identity.GetGroupId(GraphRequestHelper), Users);
         }
     }
 }

src/Commands/Microsoft365Groups/AddMicrosoft365GroupOwner.cs

@@ -2,6 +2,7 @@
 using PnP.PowerShell.Commands.Base;
 using PnP.PowerShell.Commands.Base.PipeBinds;
 using PnP.PowerShell.Commands.Utilities;
+using System;
 using System.Management.Automation;
 
 namespace PnP.PowerShell.Commands.Microsoft365Groups
@@ -16,12 +17,13 @@ public class AddMicrosoft365GroupOwner : PnPGraphCmdlet
         [Parameter(Mandatory = true)]
         public string[] Users;
 
+        [Obsolete("The parameter is obsolete and will be removed in future versions. You can use Clear-PnPMicrosoft365GroupOwner instead.")]
         [Parameter(Mandatory = false)]
         public SwitchParameter RemoveExisting;
 
         protected override void ExecuteCmdlet()
         {
-            Microsoft365GroupsUtility.AddOwners(GraphRequestHelper, Identity.GetGroupId(GraphRequestHelper), Users, RemoveExisting);
+            Microsoft365GroupsUtility.AddOwners(GraphRequestHelper, Identity.GetGroupId(GraphRequestHelper), Users);
         }
     }
 }

src/Commands/Utilities/Microsoft365GroupsUtility.cs

@@ -289,24 +289,24 @@ internal static void PermanentlyDeleteDeletedGroup(ApiRequestHelper requestHelpe
             requestHelper.Delete($"v1.0/directory/deleteditems/microsoft.graph.group/{groupId}");
         }
 
-        internal static void AddOwners(ApiRequestHelper requestHelper, Guid groupId, string[] users, bool removeExisting)
+        internal static void AddOwners(ApiRequestHelper requestHelper, Guid groupId, string[] users)
         {
-            AddUsersToGroup(requestHelper, "owners", groupId, users, removeExisting);
+            AddUsersToGroup(requestHelper, "owners", groupId, users);
         }
 
-        internal static void AddDirectoryOwners(ApiRequestHelper requestHelper, Guid groupId, Guid[] users, bool removeExisting)
+        internal static void AddDirectoryOwners(ApiRequestHelper requestHelper, Guid groupId, Guid[] users)
         {
-            AddDirectoryObjectsToGroup(requestHelper, "owners", groupId, users, removeExisting);
+            AddDirectoryObjectsToGroup(requestHelper, "owners", groupId, users);
         }
 
-        internal static void AddMembers(ApiRequestHelper requestHelper, Guid groupId, string[] users, bool removeExisting)
+        internal static void AddMembers(ApiRequestHelper requestHelper, Guid groupId, string[] users)
         {
-            AddUsersToGroup(requestHelper, "members", groupId, users, removeExisting);
+            AddUsersToGroup(requestHelper, "members", groupId, users);
         }
 
-        internal static void AddDirectoryMembers(ApiRequestHelper requestHelper, Guid groupId, Guid[] users, bool removeExisting)
+        internal static void AddDirectoryMembers(ApiRequestHelper requestHelper, Guid groupId, Guid[] users)
         {
-            AddDirectoryObjectsToGroup(requestHelper, "members", groupId, users, removeExisting);
+            AddDirectoryObjectsToGroup(requestHelper, "members", groupId, users);
         }
 
         internal static string GetUserGraphUrlForUPN(string upn)
@@ -318,7 +318,7 @@ internal static string GetUserGraphUrlForUPN(string upn)
             return $"users/{escapedUpn}";
         }
 
-        private static void AddUsersToGroup(ApiRequestHelper requestHelper, string groupName, Guid groupId, string[] users, bool removeExisting)
+        private static void AddUsersToGroup(ApiRequestHelper requestHelper, string groupName, Guid groupId, string[] users)
         {
             foreach (var user in users)
             {
@@ -338,7 +338,7 @@ private static void AddUsersToGroup(ApiRequestHelper requestHelper, string group
             }
         }
 
-        private static void AddDirectoryObjectsToGroup(ApiRequestHelper requestHelper, string groupName, Guid groupId, Guid[] directoryObjects, bool removeExisting)
+        private static void AddDirectoryObjectsToGroup(ApiRequestHelper requestHelper, string groupName, Guid groupId, Guid[] directoryObjects)
         {
             foreach (var dirObject in directoryObjects)
             {
@@ -456,7 +456,7 @@ internal static void UpdateOwners(ApiRequestHelper requestHelper, Guid groupId,
             {
                 if (existingOwners.FirstOrDefault(o => o.UserPrincipalName == owner) == null)
                 {
-                    AddOwners(requestHelper, groupId, new string[] { owner }, false);
+                    AddOwners(requestHelper, groupId, new string[] { owner });
                 }
             }
             foreach (var existingOwner in existingOwners)
@@ -475,7 +475,7 @@ internal static void UpdateMembersAsync(ApiRequestHelper requestHelper, Guid gro
             {
                 if (existingMembers.FirstOrDefault(o => o.UserPrincipalName == member) == null)
                 {
-                    AddMembers(requestHelper, groupId, new string[] { member }, false);
+                    AddMembers(requestHelper, groupId, new string[] { member });
                 }
             }
             foreach (var existingMember in existingMembers)