diff --git a/Audit Teams meetings/AuditTeamsMeetings.ps1 b/Audit Teams meetings/AuditTeamsMeetings.ps1 index bb873e8..a852285 100644 --- a/Audit Teams meetings/AuditTeamsMeetings.ps1 +++ b/Audit Teams meetings/AuditTeamsMeetings.ps1 @@ -1,21 +1,32 @@ <# ============================================================================================= -Name: Audit Microsoft Teams meetings using PowerShell +Name: Audit Microsoft Teams meetings and export teams meeting attendance report using PowerShell +Version: 2.0 Description: This script exports Teams meeting report and attendance report into 2 CSV files. website: o365reports.com Script Highlights: ~~~~~~~~~~~~~~~~~ -1. The script uses modern authentication to connect to Exchange Online. -2. The script can be executed with MFA enabled account too. +1. Exports a list of Teams meetings. +2. Exports Teams meeting attendance report. 3. Exports report results to CSV file. -4. Allows you to generate a Teams meetings audit log. -5. Exports Teams meeting attendance report. +4. The script can be executed with MFA enabled account too. +5. Supports certificate-based authentication (CBA) too. 6. Helps to generate reports for custom periods. -7. Automatically installs the EXO V2 and AzureAD module (if not installed already) upon your confirmation. -8. The script is scheduler-friendly. I.e., Credential can be passed as a parameter instead of saving inside the script. +7. Automatically installs the EXO PowerShell module (if not installed already) upon your confirmation. +8. The script is scheduler-friendly. For detailed Script execution: https://o365reports.com/2021/12/08/microsoft-teams-meeting-attendance-report + +Change Log: +~~~~~~~~~~~ + + V1.0 (Dec 09, 2021) - File created + V1.1 (Sep 28, 2023) - Minor usability improvements. + V2.0 (Mar 05, 2025) - Added certificate-based authentication support to enhance scheduling capability. + Removed Azure AD PowerShell module dependency. + Increased audit log retrieval range from 90 to 180 days + Usability improvements ============================================================================================ #> @@ -24,83 +35,82 @@ Param [Parameter(Mandatory = $false)] [Nullable[DateTime]]$StartDate, [Nullable[DateTime]]$EndDate, - [switch]$NoMFA, [string]$UserName, - [string]$Password + [string]$Password, + [string]$Organization, + [string]$ClientId, + [string]$CertificateThumbprint ) -Function Connect_Modules +#Getting StartDate and EndDate for Audit log +if ((($StartDate -eq $null) -and ($EndDate -ne $null)) -or (($StartDate -ne $null) -and ($EndDate -eq $null))) { - #Check for EXO v2 module inatallation - $Module = Get-Module ExchangeOnlineManagement -ListAvailable + Write-Host `nPlease enter both StartDate and EndDate for Audit log collection -ForegroundColor Red + exit +} +elseif(($StartDate -eq $null) -and ($EndDate -eq $null)) +{ + $StartDate=(((Get-Date).AddDays(-180))).Date + $EndDate=Get-Date +} +else +{ + $StartDate=[DateTime]$StartDate + $EndDate=[DateTime]$EndDate + if($StartDate -lt ((Get-Date).AddDays(-180))) + { + Write-Host `nAudit log can be retrieved only for past 180 days. Please select a date after (Get-Date).AddDays(-180) -ForegroundColor Red + Exit + } + if($EndDate -lt ($StartDate)) + { + Write-Host `nEnd time should be later than start time -ForegroundColor Red + Exit + } +} + +#Check for EXO module inatallation +$Module = Get-Module ExchangeOnlineManagement -ListAvailable if($Module.count -eq 0) { - Write-Host Exchange Online PowerShell V2 module is not available -ForegroundColor yellow + Write-Host Exchange Online PowerShell 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]") { Write-host "Installing Exchange Online PowerShell module" - Install-Module ExchangeOnlineManagement -Repository PSGallery -AllowClobber -Force + Install-Module ExchangeOnlineManagement -Repository PSGallery -AllowClobber -Force -Scope CurrentUser + Import-Module ExchangeOnlineManagement } else { - Write-Host EXO V2 module is required to connect Exchange Online.Please install module using Install-Module ExchangeOnlineManagement cmdlet. + Write-Host EXO module is required to connect Exchange Online.Please install module using Install-Module ExchangeOnlineManagement cmdlet. Exit } } - #Check for Azure AD module - $Module = Get-Module AzureAD -ListAvailable - if($Module.count -eq 0) - { - Write-Host Azure AD module is not available -ForegroundColor yellow - $Confirm= Read-Host Are you sure you want to install the module? [Y] Yes [N] No - if($Confirm -match "[yY]") - { - Write-host "Installing AzureAD PowerShell module" - Install-Module AzureAD -Repository PSGallery -AllowClobber -Force - } - else - { - Write-Host AzureAD module is required to generate the report.Please install module using Install-Module AzureAD cmdlet. - Exit - } - } - - #Authentication using non-MFA - if($NoMFA.IsPresent) + Write-Host Connecting to Exchange Online... + #Storing credential in script for scheduling purpose/ Passing credential as parameter - Authentication using non-MFA account + if(($AdminName -ne "") -and ($Password -ne "")) { - #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 - } - else - { - $Credential=Get-Credential -Credential $null - } - Write-Host "Connecting Azure AD..." - Connect-AzureAD -Credential $Credential | Out-Null - Write-Host "Connecting Exchange Online PowerShell..." - Connect-ExchangeOnline -Credential $Credential + $SecuredPassword = ConvertTo-SecureString -AsPlainText $Password -Force + $Credential = New-Object System.Management.Automation.PSCredential $AdminName,$SecuredPassword + Connect-ExchangeOnline -Credential $Credential -ShowBanner:$false + } + elseif($Organization -ne "" -and $ClientId -ne "" -and $CertificateThumbprint -ne "") + { + Connect-ExchangeOnline -AppId $ClientId -CertificateThumbprint $CertificateThumbprint -Organization $Organization -ShowBanner:$false } - #Connect to Exchange Online and AzureAD module using MFA else { - Write-Host "Connecting Exchange Online PowerShell..." - Connect-ExchangeOnline - Write-Host "Connecting Azure AD..." - Connect-AzureAD | Out-Null + Connect-ExchangeOnline -ShowBanner:$false } -} Function Get_TeamMeetings { $Result="" $Results=@() - $Count=0 + Write-Host `nRetrieving Teams meeting details from $StartDate to $EndDate... Search-UnifiedAuditLog -StartDate $StartDate -EndDate $EndDate -Operations "MeetingDetail" -ResultSize 5000 | ForEach-Object { - $Count++ + $Global:MeetingCount++ Write-Progress -Activity "`n Retrieving Teams meetings data from $StartDate to $EndDate.."`n" Processed Teams meetings count: $Count" $AuditData=$_.AuditData | ConvertFrom-Json $MeetingID=$AuditData.ID @@ -113,11 +123,18 @@ Function Get_TeamMeetings $Results= New-Object PSObject -Property $Result $Results | Select-Object 'Meeting id','Created By','Start Time','End Time','Meeting Type','Meeting Link','More Info' | Export-Csv -Path $ExportCSV -Notype -Append } - Write-Host $Count meetings details are exported. -ForegroundColor Green + if($MeetingCount -ne 0) + { + Write-Host $Global:MeetingCount meetings details are exported. + } + else + { + Write-Host "No meetings found" + } } -$MaxStartDate=((Get-Date).AddDays(-89)).Date -#Getting Teams meeting attendance report for past 90 days +$MaxStartDate=((Get-Date).AddDays(-180)).Date +#Getting Teams meeting attendance report for past 180 days if(($StartDate -eq $null) -and ($EndDate -eq $null)) { $EndDate=(Get-Date)#.Date @@ -128,7 +145,7 @@ While($true) { if ($StartDate -eq $null) { - $StartDate=Read-Host Enter start time for report generation '(Eg:11/23/2021)' + $StartDate=Read-Host Enter start time for report generation '(Eg:11/23/2024)' } Try { @@ -139,7 +156,7 @@ While($true) } else { - Write-Host `nAudit can be retrieved only for past 90 days. Please select a date after $MaxStartDate -ForegroundColor Red + Write-Host `nAudit can be retrieved only for past 180 days. Please select a date after $MaxStartDate -ForegroundColor Red return } } @@ -155,7 +172,7 @@ While($true) { if ($EndDate -eq $null) { - $EndDate=Read-Host Enter End time for report generation '(Eg: 11/23/2021)' + $EndDate=Read-Host Enter End time for report generation '(Eg: 11/23/2024)' } Try { @@ -190,107 +207,104 @@ if($CurrentStart -eq $CurrentEnd) Write-Host Start and end time are same.Please enter different time range -ForegroundColor Red Exit } - -Connect_Modules +$Global:MeetingCount=0 Get_TeamMeetings -$CurrentResultCount=0 -$AggregateResultCount=0 -Write-Host `nGenerating Teams meeting attendance report from $StartDate to $EndDate... -$ProcessedAuditCount=0 -$OutputEvents=0 -$ExportResult="" -$ExportResults=@() -$RetriveOperation="MeetingParticipantDetail" -while($true) -{ - #Getting Teams meeting participants report for the given time range - Search-UnifiedAuditLog -StartDate $CurrentStart -EndDate $CurrentEnd -Operations $RetriveOperation -SessionId s -SessionCommand ReturnLargeSet -ResultSize 5000 | ForEach-Object { - $ResultCount++ - $ProcessedAuditCount++ - Write-Progress -Activity "`n Retrieving Team meeting participant report..."`n" Processed audit record count: $ProcessedAuditCount" - $AuditData=$_.AuditData | ConvertFrom-Json - $MeetingID=$AuditData.MeetingDetailId - $CreatedBy=$_.UserIDs - $AttendeesInfo=($AuditData.Attendees) - $Attendees=$AttendeesInfo.userObjectId - $AttendeesType=$AttendeesInfo.RecipientType - if($AttendeesType -ne "User") + +#Get participants details if any meetings found +if($Global:MeetingCount -ne 0) +{ + $CurrentResultCount=0 + $AggregateResultCount=0 + Write-Host `nGenerating Teams meeting attendance report from $StartDate to $EndDate... + $ProcessedAuditCount=0 + $OutputEvents=0 + $ExportResult="" + $ExportResults=@() + $RetriveOperation="MeetingParticipantDetail" + while($true) + { + #Getting Teams meeting participants report for the given time range + $Results=Search-UnifiedAuditLog -StartDate $CurrentStart -EndDate $CurrentEnd -Operations $RetriveOperation -SessionId s -SessionCommand ReturnLargeSet -ResultSize 5000 + $ResultsCount=($Results|Measure-Object).count + foreach($Result in $Results) { - $Attendees=$AttendeesInfo.DisplayName - } - else - { - $Attendees=(Get-AzureADUser -ObjectId $Attendees).UserPrincipalName - } - $JoinTime=(Get-Date($AuditData.JoinTime)).ToLocalTime() #Get-Date($AuditData.JoinTime) Uncomment to view the Activity Time in UTC - $LeaveTime=(Get-Date($AuditData.LeaveTime)).ToLocalTime() + $ProcessedAuditCount++ + Write-Progress -Activity "`n Retrieving Team meeting participant report..."`n" Processed audit record count: $ProcessedAuditCount" + $AuditData=$Result.AuditData | ConvertFrom-Json + $MeetingID=$AuditData.MeetingDetailId + $CreatedBy=$Result.UserIDs + $AttendeesInfo=($AuditData.Attendees) + $Attendees=$AttendeesInfo.userObjectId + $AttendeesType=$AttendeesInfo.RecipientType + if($AttendeesType -ne "User") + { + $Attendees=$AttendeesInfo.DisplayName + } + else + { + $Attendees=(Get-ExoRecipient -Identity $Attendees).DisplayName + } + $JoinTime=(Get-Date($AuditData.JoinTime)).ToLocalTime() #Get-Date($AuditData.JoinTime) Uncomment to view the Activity Time in UTC + $LeaveTime=(Get-Date($AuditData.LeaveTime)).ToLocalTime() - #Export result to csv - $OutputEvents++ - $ExportResult=@{'Meeting id'=$MeetingID;'Created By'=$CreatedBy;'Attendees'=$Attendees;'Attendee Type'=$AttendeesType;'Joined Time'=$JoinTime;'Left Time'=$LeaveTime;'More Info'=$AuditData} - $ExportResults= New-Object PSObject -Property $ExportResult - $ExportResults | Select-Object 'Meeting id','Created By','Attendees','Attendee Type','Joined Time','Left Time','More Info' | Export-Csv -Path $OutputCSV -Notype -Append - } - - $currentResultCount=$currentResultCount+$ResultCount - if($CurrentResultCount -ge 50000) - { - Write-Host Retrieved max record for current range.Proceeding further may cause data loss or rerun the script with reduced time interval. -ForegroundColor Red - $Confirm=Read-Host `nAre you sure you want to continue? [Y] Yes [N] No - if($Confirm -match "[Y]") + #Export result to csv + $OutputEvents++ + $ExportResult=@{'Meeting id'=$MeetingID;'Created By'=$CreatedBy;'Attendees'=$Attendees;'Attendee Type'=$AttendeesType;'Joined Time'=$JoinTime;'Left Time'=$LeaveTime;'More Info'=$AuditData} + $ExportResults= New-Object PSObject -Property $ExportResult + $ExportResults | Select-Object 'Meeting id','Created By','Attendees','Attendee Type','Joined Time','Left Time','More Info' | Export-Csv -Path $OutputCSV -Notype -Append + } + $currentResultCount=$CurrentResultCount+$ResultsCount + Write-Progress -Activity "`n Retrieving audit log for $CurrentStart : $CurrentResultCount records"`n" Total processed audit record count: $AggregateResults" + if(($CurrentResultCount -eq 50000) -or ($ResultsCount -lt 5000)) { - Write-Host Proceeding audit log collection with data loss + if($CurrentResultCount -eq 50000) + { + Write-Host Retrieved max record for the current range.Proceeding further may cause data loss or rerun the script with reduced time interval. -ForegroundColor Red + $Confirm=Read-Host `nAre you sure you want to continue? [Y] Yes [N] No + if($Confirm -notmatch "[Y]") + { + Write-Host Please rerun the script with reduced time interval -ForegroundColor Red + Exit + } + else + { + Write-Host Proceeding audit log collection with data loss + } + } + #Check for last iteration + if(($CurrentEnd -eq $EndDate)) + { + break + } [DateTime]$CurrentStart=$CurrentEnd + #Break loop if start date exceeds current date(There will be no data) + if($CurrentStart -gt (Get-Date)) + { + break + } [DateTime]$CurrentEnd=$CurrentStart.AddMinutes($IntervalTimeInMinutes) - $CurrentResultCount=0 if($CurrentEnd -gt $EndDate) { $CurrentEnd=$EndDate } - } - else - { - Write-Host Please rerun the script with reduced time interval -ForegroundColor Red - Exit + + $CurrentResultCount=0 + $CurrentResult = @() } } - - if($ResultCount -lt 5000) - { - if($CurrentEnd -eq $EndDate) - { - break - } - $CurrentStart=$CurrentEnd - if($CurrentStart -gt (Get-Date)) - { - break - } - $CurrentEnd=$CurrentStart.AddMinutes($IntervalTimeInMinutes) - $CurrentResultCount=0 - if($CurrentEnd -gt $EndDate) - { - $CurrentEnd=$EndDate - } - } - $ResultCount=0 } #Open output file after execution -If($OutputEvents -eq 0) -{ - Write-Host No records found -} -else -{ - Write-Host `nThe Teams meeting attendance report contains $OutputEvents audit records -ForegroundColor Green + Write-Host `n~~ Script prepared by AdminDroid Community ~~`n -ForegroundColor Green + Write-Host "~~ Check out " -NoNewline -ForegroundColor Green; Write-Host "admindroid.com" -ForegroundColor Yellow -NoNewline; + Write-Host " to get access to 1900+ Microsoft 365 reports. ~~" -ForegroundColor Green `n + if((Test-Path -Path $OutputCSV) -eq "True") { + Write-Host `nThe Teams meeting attendance report contains $OutputEvents audit records Write-Host `n" The Teams meetings attendance report available in: " -NoNewline -ForegroundColor Yellow; Write-Host "$OutputCSV" - Write-Host `n~~ Script prepared by AdminDroid Community ~~`n -ForegroundColor Green - Write-Host "~~ Check out " -NoNewline -ForegroundColor Green; Write-Host "admindroid.com" -ForegroundColor Yellow -NoNewline; - Write-Host " to get access to 1800+ Microsoft 365 reports. ~~" -ForegroundColor Green `n`n + $Prompt = New-Object -ComObject wscript.shell $UserInput = $Prompt.popup("Do you want to open output file?",` 0,"Open Output File",4) @@ -300,9 +314,7 @@ else Invoke-Item "$ExportCSV" } } -} + #Disconnect Exchange Online session -Disconnect-ExchangeOnline -Confirm:$false -InformationAction Ignore -ErrorAction SilentlyContinue - - +Disconnect-ExchangeOnline -Confirm:$false -InformationAction Ignore -ErrorAction SilentlyContinue \ No newline at end of file