mirror of
https://github.com/admindroid-community/powershell-scripts.git
synced 2025-12-17 16:35:19 +00:00
Microsoft 365 group report
Microsoft 365 group report
This commit is contained in:
AdminDroid
parent
e3d25070f7
commit
57d5d439c2
214
Microsoft 365 Group Report/M365GroupReport.ps1
Normal file
214
Microsoft 365 Group Report/M365GroupReport.ps1
Normal file
@ -0,0 +1,214 @@
|
||||
<#
|
||||
=============================================================================================
|
||||
Name: Microsoft 365 Group Report
|
||||
Description: This script exports Microsoft 365 groups and their membership to CSV
|
||||
Version: 1.0
|
||||
website: o365reports.com
|
||||
Script by: O365Reports Team
|
||||
For detailed Script execution: https://o365reports.com/2021/02/11/export-microsoft-365-group-report-to-csv-using-powershell
|
||||
============================================================================================
|
||||
#>
|
||||
|
||||
Param
|
||||
(
|
||||
[Parameter(Mandatory = $false)]
|
||||
[string]$GroupIDsFile,
|
||||
[switch]$DistributionList,
|
||||
[switch]$Security,
|
||||
[switch]$MailEnabledSecurity,
|
||||
[Switch]$IsEmpty,
|
||||
[Int]$MinGroupMembersCount,
|
||||
[string]$UserName,
|
||||
[string]$Password
|
||||
)
|
||||
|
||||
Function Get_members
|
||||
{
|
||||
$DisplayName=$_.DisplayName
|
||||
Write-Progress -Activity "`n Processed Group count: $Count "`n" Getting members of: $DisplayName"
|
||||
$EmailAddress=$_.EmailAddress
|
||||
$GroupType=$_.GroupType
|
||||
$ObjectId=$_.ObjectId
|
||||
$Recipient=""
|
||||
$RecipientHash=@{}
|
||||
for($KeyIndex = 0; $KeyIndex -lt $RecipientTypeArray.Length; $KeyIndex += 2)
|
||||
{
|
||||
$key=$RecipientTypeArray[$KeyIndex]
|
||||
$Value=$RecipientTypeArray[$KeyIndex+1]
|
||||
$RecipientHash.Add($key,$Value)
|
||||
}
|
||||
$Members=Get-MsolGroupMember -All -GroupObjectId $ObjectId
|
||||
$MembersCount=$Members.Count
|
||||
|
||||
#Filter for security group
|
||||
if(($Security.IsPresent) -and ($GroupType -ne "Security"))
|
||||
{
|
||||
Return
|
||||
}
|
||||
|
||||
#Filter for Distribution list
|
||||
if(($DistributionList.IsPresent) -and ($GroupType -ne "DistributionList"))
|
||||
{
|
||||
Return
|
||||
}
|
||||
|
||||
#Filter for mail enabled security group
|
||||
if(($MailEnabledSecurity.IsPresent) -and ($GroupType -ne "MailEnabledSecurity"))
|
||||
{
|
||||
Return
|
||||
}
|
||||
|
||||
#GroupSize Filter
|
||||
if(([int]$MinGroupMembersCount -ne "") -and ($MembersCount -lt [int]$MinGroupMembersCount))
|
||||
{
|
||||
Return
|
||||
}
|
||||
#Check for Empty Group
|
||||
elseif($MembersCount -eq 0)
|
||||
{
|
||||
$MemberName="No Members"
|
||||
$MemberEmail="-"
|
||||
$RecipientTypeDetail="-"
|
||||
Print_Output
|
||||
}
|
||||
|
||||
#Loop through each member in a group
|
||||
else
|
||||
{
|
||||
foreach($Member in $Members)
|
||||
{
|
||||
if($IsEmpty.IsPresent)
|
||||
{
|
||||
return
|
||||
}
|
||||
$MemberName=$Member.DisplayName
|
||||
$MemberType=$Member.GroupMemberType
|
||||
$MemberEmail=$Member.EmailAddress
|
||||
if($MemberEmail -eq "")
|
||||
{
|
||||
$MemberEmail="-"
|
||||
}
|
||||
#Get Counts by RecipientTypeDetail
|
||||
foreach($key in [object[]]$Recipienthash.Keys)
|
||||
{
|
||||
if(($MemberType -eq $key) -eq "true")
|
||||
{
|
||||
[int]$RecipientHash[$key]+=1
|
||||
}
|
||||
}
|
||||
Print_Output
|
||||
}
|
||||
}
|
||||
|
||||
#Order RecipientTypeDetail based on count
|
||||
$Hash=@{}
|
||||
$Hash=$RecipientHash.GetEnumerator() | Sort-Object -Property value -Descending |foreach{
|
||||
if([int]$($_.Value) -gt 0 )
|
||||
{
|
||||
if($Recipient -ne "")
|
||||
{ $Recipient+=";"}
|
||||
$Recipient+=@("$($_.Key) - $($_.Value)")
|
||||
}
|
||||
if($Recipient -eq "")
|
||||
{$Recipient="-"}
|
||||
}
|
||||
#Print Summary report
|
||||
$Result=@{'DisplayName'=$DisplayName;'EmailAddress'=$EmailAddress;'GroupType'=$GroupType;'GroupMembersCount'=$MembersCount;'MembersCountByType'=$Recipient}
|
||||
$Results= New-Object PSObject -Property $Result
|
||||
$Results | Select-Object DisplayName,EmailAddress,GroupType,GroupMembersCount,MembersCountByType | Export-Csv -Path $ExportSummaryCSV -Notype -Append
|
||||
}
|
||||
|
||||
#Print Detailed Output
|
||||
Function Print_Output
|
||||
{
|
||||
$Result=@{'GroupName'=$DisplayName;'GroupEmailAddress'=$EmailAddress;'Member'=$MemberName;'MemberEmail'=$MemberEmail;'MemberType'=$MemberType}
|
||||
$Results= New-Object PSObject -Property $Result
|
||||
$Results | Select-Object GroupName,GroupEmailAddress,Member,MemberEmail,MemberType | Export-Csv -Path $ExportCSV -Notype -Append
|
||||
}
|
||||
|
||||
Function main()
|
||||
{
|
||||
#Check for MSOnline module
|
||||
$Module=Get-Module -Name MSOnline -ListAvailable
|
||||
if($Module.count -eq 0)
|
||||
{
|
||||
Write-Host MSOnline module is not available -ForegroundColor yellow
|
||||
$Confirm= Read-Host Are you sure you want to install module? [Y] Yes [N] No
|
||||
if($Confirm -match "[yY]")
|
||||
{
|
||||
Install-Module MSOnline
|
||||
Import-Module MSOnline
|
||||
}
|
||||
else
|
||||
{
|
||||
Write-Host MSOnline module is required to connect AzureAD.Please install module using Install-Module MSOnline cmdlet.
|
||||
Exit
|
||||
}
|
||||
}
|
||||
Write-Host Connecting to Office 365...
|
||||
#Storing credential in script for scheduling purpose/ Passing credential as parameter
|
||||
if(($UserName -ne "") -and ($Password -ne ""))
|
||||
{
|
||||
$SecuredPassword = ConvertTo-SecureString -AsPlainText $Password -Force
|
||||
$Credential = New-Object System.Management.Automation.PSCredential $UserName,$SecuredPassword
|
||||
Connect-MsolService -Credential $credential
|
||||
}
|
||||
else
|
||||
{
|
||||
Connect-MsolService | Out-Null
|
||||
}
|
||||
|
||||
#Set output file
|
||||
$ExportCSV=".\M365Group-DetailedMembersReport_$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv" #Detailed report
|
||||
$ExportSummaryCSV=".\M365Group-SummaryReport_$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv" #Summary report
|
||||
|
||||
#Get a list of RecipientTypeDetail
|
||||
$RecipientTypeArray=Get-Content -Path .\RecipientTypeDetails.txt -ErrorAction Stop
|
||||
$Result=""
|
||||
$Results=@()
|
||||
$Count=0
|
||||
|
||||
#Check for input file
|
||||
if([string]$GroupIDssFile -ne "")
|
||||
{
|
||||
#We have an input file, read it into memory
|
||||
$DG=@()
|
||||
$DG=Import-Csv -Header "DisplayName" $GroupIDsFile
|
||||
foreach($item in $DG)
|
||||
{
|
||||
Get-MsolGroup -ObjectId $item.displayname | Foreach{
|
||||
$Count++
|
||||
Get_Members}
|
||||
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
#Get all Office 365 group
|
||||
Get-MsolGroup -All | Foreach{
|
||||
$Count++
|
||||
Get_Members
|
||||
}
|
||||
}
|
||||
|
||||
#Open output file after execution
|
||||
Write-Host `nScript executed successfully
|
||||
if((Test-Path -Path $ExportCSV) -eq "True")
|
||||
{
|
||||
Write-Host Detailed report available in: $ExportCSV
|
||||
Write-host Summary report available in: $ExportSummaryCSV
|
||||
$Prompt = New-Object -ComObject wscript.shell
|
||||
$UserInput = $Prompt.popup("Do you want to open output file?",`
|
||||
0,"Open Output File",4)
|
||||
If ($UserInput -eq 6)
|
||||
{
|
||||
Invoke-Item "$ExportCSV"
|
||||
Invoke-Item "$ExportSummaryCSV"
|
||||
}
|
||||
}
|
||||
Else
|
||||
{
|
||||
Write-Host No Group found.
|
||||
}
|
||||
}
|
||||
. main
|
||||
82
Microsoft 365 Group Report/RecipientTypeDetails.txt
Normal file
82
Microsoft 365 Group Report/RecipientTypeDetails.txt
Normal file
@ -0,0 +1,82 @@
|
||||
Group
|
||||
0
|
||||
User
|
||||
0
|
||||
Contact
|
||||
0
|
||||
UserMailbox
|
||||
0
|
||||
LinkedMailbox
|
||||
0
|
||||
SharedMailbox
|
||||
0
|
||||
LegacyMailbox
|
||||
0
|
||||
RoomMailbox
|
||||
0
|
||||
EquipmentMailbox
|
||||
0
|
||||
MailContact
|
||||
0
|
||||
MailUser
|
||||
0
|
||||
MailUniversalDistributionGroup
|
||||
0
|
||||
MailNonUniversalGroup
|
||||
0
|
||||
MailUniversalSecurityGroup
|
||||
0
|
||||
DynamicDistributionGroup
|
||||
0
|
||||
PublicFolder
|
||||
0
|
||||
SystemAttendantMailbox
|
||||
0
|
||||
SystemMailbox
|
||||
0
|
||||
MailForestContact
|
||||
0
|
||||
UniversalDistributionGroup
|
||||
0
|
||||
UniversalSecurityGroup
|
||||
0
|
||||
NonUniversalGroup
|
||||
0
|
||||
DisabledUser
|
||||
0
|
||||
MicrosoftExchange
|
||||
0
|
||||
ArbitrationMailbox
|
||||
0
|
||||
MailboxPlan
|
||||
0
|
||||
LinkedUser
|
||||
0
|
||||
RoomList
|
||||
0
|
||||
DiscoveryMailbox
|
||||
0
|
||||
RoleGroup
|
||||
0
|
||||
RemoteUserMailbox
|
||||
0
|
||||
Computer
|
||||
0
|
||||
RemoteRoomMailbox
|
||||
0
|
||||
RemoteEquipmentMailbox
|
||||
0
|
||||
RemoteSharedMailbox
|
||||
0
|
||||
PublicFolderMailbox
|
||||
0
|
||||
TeamMailbox
|
||||
0
|
||||
RemoteTeamMailbox
|
||||
0
|
||||
MonitoringMailbox
|
||||
0
|
||||
GroupMailbox
|
||||
0
|
||||
AllUniqueRecipientTypes
|
||||
0
|
||||
Loading…
x
Reference in New Issue
Block a user