Skip to content

Get-GroupMember-Html

Azure AD: HTML report of group members

#Requires -Version 5.1
#Requires -Modules AzureAD

[CmdletBinding(DefaultParameterSetName = "GroupName")]
Param(
    [Parameter(Mandatory = $true, ParameterSetName = "GroupObjectId")]
    [guid]$GroupObjectId,

    [Parameter(Mandatory = $true, ParameterSetName = "GroupName")]
    [string]$GroupName,

    [Parameter(ParameterSetName = "GroupName")]
    [Parameter(ParameterSetName = "GroupObjectId")]
    [switch]$Nested,

    [Parameter(ParameterSetName = "GroupName")]
    [Parameter(ParameterSetName = "GroupObjectId")]
    [ValidateSet('All', 'Users', 'Groups')]
    [string]$MemberObjectTypes = 'All'
)

Process {
    try {
        $members = [System.Collections.ArrayList]::new()

        function Get-NestedMembers {
            param($group)

            $null = $members.Add([PSCustomObject]@{ Type = 'Group'; DisplayName = $group.DisplayName })

            if (($MemberObjectTypes -eq 'All') -or ($MemberObjectTypes -eq 'Users')) {
                $users = Get-AzureADGroupMember -ObjectId $group.ObjectId -ErrorAction Stop | Where-Object { $_.ObjectType -eq 'User' } | Sort-Object -Property DisplayName
                foreach ($u in $users) { $null = $members.Add([PSCustomObject]@{ Type = 'User'; DisplayName = $u.DisplayName }) }
            }

            if (($MemberObjectTypes -eq 'All') -or ($MemberObjectTypes -eq 'Groups')) {
                $childGroups = Get-AzureADGroupMember -ObjectId $group.ObjectId -ErrorAction Stop | Where-Object { $_.ObjectType -eq 'Group' } | Sort-Object -Property DisplayName
                foreach ($cg in $childGroups) {
                    if ($Nested) { Get-NestedMembers $cg }
                    else { $null = $members.Add([PSCustomObject]@{ Type = 'Group'; DisplayName = $cg.DisplayName }) }
                }
            }
        }

        if ($PSCmdlet.ParameterSetName -eq "GroupObjectId") {
            $grp = Get-AzureADGroup -ObjectId $GroupObjectId -ErrorAction Stop
        }
        else {
            $grp = Get-AzureADGroup -All $true -ErrorAction Stop | Where-Object { $_.Displayname -eq $GroupName }
        }

        if ($null -eq $grp) { throw "Group not found" }

        Get-NestedMembers $grp

        if ($members.Count -gt 0) {
            Write-Output ($members | ConvertTo-Html -Fragment)
        }
        else { Write-Output "No members found" }
    }
    catch { throw }
}

Unique object ID of the group

Display name of the group

Off

Recursively enumerate nested groups

Filter by member type: All, Users, or Groups

An interactive directory of PowerShell scripts.