public/Add-EntraIdGroupMember.ps1
|
<# .SYNOPSIS Adds members to an Entra ID (Azure AD) group by group Id or display name. .DESCRIPTION This function adds specified members to an Entra ID group using Microsoft Graph. It supports searching for the group by Id or display name. Members can be users or other groups, identified by their UPN or display name. .PARAMETER GroupId The object Id (GUID) of the Entra ID group to add members to. .PARAMETER GroupDisplayName The display name of the Entra ID group to add members to. .PARAMETER Members An array of user principal names (UPNs) or group display names to add as members. .EXAMPLE Add-EntraIdGroupMember -GroupId "00000000-0000-0000-0000-000000000001" -Members @("user1@contoso.com", "user2@contoso.com") Adds the specified users to the group with the specified Id. .EXAMPLE Add-EntraIdGroupMember -GroupDisplayName "My Security Group" -Members @("user1@contoso.com", "user2@contoso.com") Adds the specified users to the group with the specified display name. .NOTES This function requires Microsoft Graph PowerShell SDK to be installed and authenticated. #> function Add-EntraIdGroupMember { [CmdletBinding(DefaultParameterSetName='ById', SupportsShouldProcess = $true)] param( [Parameter(Mandatory, ParameterSetName='ById', Position=0, ValueFromPipeline, ValueFromPipelineByPropertyName)] [string]$GroupId, [Parameter(Mandatory, ParameterSetName='ByDisplayName', Position=0, ValueFromPipeline, ValueFromPipelineByPropertyName)] [string]$GroupDisplayName, [Parameter(Mandatory)] [array]$Members ) process { if ($PSCmdlet.ShouldProcess("Group: $GroupDisplayName ($GroupId)", "Add specified members")) { Test-GraphAuth # Resolve group Id or group display name based on parameter set switch ($PSCmdlet.ParameterSetName) { 'ByDisplayName' { $group = Get-MgGroup -Filter "displayName eq '$GroupDisplayName'" | Select-Object -First 1 if (-not $group) { Write-Warning "No group found with display name '$GroupDisplayName'." return } $GroupId = $group.Id } 'ById' { $group = Get-MgGroup -GroupId $GroupId if (-not $group) { Write-Warning "No group found with Id '$GroupId'." return } $GroupDisplayName = $group.DisplayName } } # Get current members (UPNs) $currentMembers = Get-EntraIdGroupMember -GroupDisplayName $GroupDisplayName # Add missing members $toAdd = $Members | Where-Object { $_ -notin $currentMembers } foreach ($memberEntry in $toAdd) { if ($memberEntry -like '*@*') { # User $userObj = Get-EntraIdUser -UserPrincipalName $memberEntry if ($userObj) { $userId = $userObj.Id New-MgGroupMember -GroupId "$GroupId" -DirectoryObjectId "$userId" Write-Output "Added user $memberEntry as member of group $GroupDisplayName ($GroupId)." } else { Write-Warning "User not found: $memberEntry" } } else { # Group $groupMemberObj = Get-EntraIdGroup -DisplayName $memberEntry if ($groupMemberObj) { $groupMemberId = $groupMemberObj.Id New-MgGroupMember -GroupId "$GroupId" -DirectoryObjectId "$groupMemberId" Write-Output "Added group $memberEntry as member of group $GroupDisplayName ($GroupId)." } else { Write-Warning "Group not found: $memberEntry" } } } } } } |