start-collectOffice365MailboxFolders.ps1
|
function start-collectOffice365MailboxFolders { <# .SYNOPSIS This function collects all of the mailbox permissions for folders in office 365 mailboxes. .DESCRIPTION Trigger function. .PARAMETER logFolder *REQUIRED* The location where logging for the migration should occur including all XML outputs for backups. .PARAMETER exchangeCredential *REQUIRED IF HYBRID MAIL FLOW ENABLED* This is the credential utilized to establish remote powershell sessions to Exchange on-premises. This acccount requires Exchange Organization Management rights in order to enable hybrid mail flow. .OUTPUTS Logs all activities and backs up all original data to the log folder directory. Moves the distribution group from on premieses source of authority to office 365 source of authority. .EXAMPLE Start-collectOnPremFolderPermissions -exchangeServer Server -exchangeCredential $credential #> #Portions of the audit code adapted from Tony Redmon's project. #https://github.com/12Knocksinna/Office365itpros/blob/master/ReportPermissionsFolderLevel.PS1 #Don't tell him - he can get grumpy at times. [cmdletbinding()] Param ( [Parameter(Mandatory = $true)] [string]$logFolderPath, [Parameter(Mandatory = $false)] [pscredential]$exchangeOnlineCredential=$NULL, [Parameter(Mandatory = $false)] [string]$exchangeOnlineCertificateThumbPrint="", [Parameter(Mandatory = $false)] [string]$exchangeOnlineOrganizationName="", [Parameter(Mandatory = $false)] [ValidateSet("O365Default","O365GermanyCloud","O365China","O365USGovGCCHigh","O365USGovDoD")] [string]$exchangeOnlineEnvironmentName="O365Default", [Parameter(Mandatory = $false)] [string]$exchangeOnlineAppID="", [Parameter(Mandatory = $false)] [boolean]$retryCollection=$FALSE, [Parameter(Mandatory = $false)] $bringMyOwnMailboxes=$NULL ) #Delare global variables. $global:logFile=$NULL #This is the global variable for the calculated log file name [string]$global:staticFolderName="\AuditData\" #Declare function variables. $auditMailboxes=$NULL $auditFolders=$NULL [array]$auditFolderNames=@() [array]$auditFolderPermissions=@() [int]$forCounter=0 [int]$mailboxCounter=0 [int]$totalMailboxes=0 [string]$office365MailboxFolderPermissions="office365MailboxFolderPermissions.xml" [string]$office365MailboxList="office365MailboxList.xml" [string]$office365MailboxProcessed="office365MailboxProcessed.xml" [int]$auditPermissionsFound=0 new-LogFile -groupSMTPAddress Office365MailboxFolderPermissions -logFolderPath $logFolderPath #Validate that only one method of engaging exchange online was specified. Out-LogFile -string "Validating Exchange Online Credentials." if (($exchangeOnlineCredential -ne $NULL) -and ($exchangeOnlineCertificateThumbPrint -ne "")) { Out-LogFile -string "ERROR: Only one method of cloud authentication can be specified. Use either cloud credentials or cloud certificate thumbprint." -isError:$TRUE } elseif (($exchangeOnlineCredential -eq $NULL) -and ($exchangeOnlineCertificateThumbPrint -eq "")) { out-logfile -string "ERROR: One permissions method to connect to Exchange Online must be specified." -isError:$TRUE } else { Out-LogFile -string "Only one method of Exchange Online authentication specified." } #Validate that all information for the certificate connection has been provieed. if (($exchangeOnlineCertificateThumbPrint -ne "") -and ($exchangeOnlineOrganizationName -eq "") -and ($exchangeOnlineAppID -eq "")) { out-logfile -string "The exchange organiztion name and application ID are required when using certificate thumbprint authentication to Exchange Online." -isError:$TRUE } elseif (($exchangeOnlineCertificateThumbPrint -ne "") -and ($exchangeOnlineOrganizationName -ne "") -and ($exchangeOnlineAppID -eq "")) { out-logfile -string "The exchange application ID is required when using certificate thumbprint authentication." -isError:$TRUE } elseif (($exchangeOnlineCertificateThumbPrint -ne "") -and ($exchangeOnlineOrganizationName -eq "") -and ($exchangeOnlineAppID -ne "")) { out-logfile -string "The exchange organization name is required when using certificate thumbprint authentication." -isError:$TRUE } else { out-logfile -string "All components necessary for Exchange certificate thumbprint authentication were specified." } #Ensure bring your own mailboes not included with retry. if (($bringMyOwnMailboxes -ne $NULL)-and ($retryCollection -EQ $TRUE)) { out-logfile -string "Cannot combine bring your own mailboxes with retry collection." out-logfile -string "If this is a retry after bringning your own mailbox - specify just retry." -isError:$TRUE -isAudit:$true } #Start the connection to Exchange Online. if ($exchangeOnlineCredential -ne $NULL) { #User specified non-certifate authentication credentials. try { New-ExchangeOnlinePowershellSession -exchangeOnlineCredentials $exchangeOnlineCredential -exchangeOnlineEnvironmentName $exchangeOnlineEnvironmentName } catch { out-logfile -string "Unable to create the exchange online connection using credentials." out-logfile -string $_ -isError:$TRUE } } elseif ($exchangeOnlineCertificateThumbPrint -ne "") { #User specified thumbprint authentication. try { new-ExchangeOnlinePowershellSession -exchangeOnlineCertificateThumbPrint $exchangeOnlineCertificateThumbPrint -exchangeOnlineAppId $exchangeOnlineAppID -exchangeOnlineOrganizationName $exchangeOnlineOrganizationName -exchangeOnlineEnvironmentName $exchangeOnlineEnvironmentName } catch { out-logfile -string "Unable to create the exchange online connection using certificate." out-logfile -string $_ -isError:$TRUE } } #Define the log file path one time. $logFolderPath = $logFolderPath+$global:staticFolderName try { if ($retryCollection -eq $FALSE) { if ($bringMyOwnMailboxes -eq $NULL) { out-logFile -string "Obtaining all office 365 mailboxes." $auditMailboxes = get-exomailbox -resultsize unlimited #Exporting mailbox operations to csv - the goal here will be to allow retry. $fileName = $office365MailboxList $exportFile=Join-path $logFolderPath $fileName $auditMailboxes | export-clixml -path $exportFile } else { out-logfile -string "Using the mailboxes that the administrator provided." out-logfile -string "Following the same logic as our get so that the retry file aligns if necessary." $auditMailboxes = $bringMyOwnMailboxes #Exporting mailbox operations to csv - the goal here will be to allow retry. $fileName = $office365MailboxList $exportFile=Join-path $logFolderPath $fileName $auditMailboxes | export-clixml -path $exportFile } } elseif ($retryCollection -eq $TRUE) { out-logfile -string "Retry operation - importing the mailboxes from previous export." try{ $fileName = $office365MailboxList $importFile=Join-path $logFolderPath $fileName $auditMailboxes = import-clixml -path $importFile } catch{ out-logfile -string "Retry was specified - unable to import the XML file." out-logfile -string $_ -isError:$TRUE -isAudit:$true } out-logfile -string "Import the count of the last mailbox processed." try { $fileName = $office365MailboxProcessed $importFile=Join-path $logFolderPath $fileName $mailboxCounter=Import-Clixml -path $importFile #The import represents the last mailbox processed. #It's permissions were already exported - add 1 to start with the next mailbox in the list. $mailboxCounter=$mailboxCounter+1 out-logfile -string ("Next mailbox to process = "+$mailboxCounter.toString()) } catch { out-logfile -string "Unable to read the previous mailbox processed." out-logfile -string $_ -isError:$TRUE -isAudit:$true } out-logfile -string "Importing the previously exported permissions." try { $fileName=$office365MailboxFolderPermissions $importFile=Join-path $logFolderPath $fileName $auditFolderPermissions = import-clixml -Path $importFile } catch { out-logfile -string "Unable to import the previously exported permissions." } } } catch { out-logFile -string "Unable to get mailboxes." out-logfile -string $_ -isError:$TRUE } #For each mailbox - we will iterate and grab the folders for processing. out-logfile -string "Gathering mailbox folders for assessment." $ProgressDelta = 100/($auditMailboxes.count); $PercentComplete = 0; $MbxNumber = 0 $totalMailboxes=$auditMailboxes.count #Here we're going to use a for loop based on count. #This is to support a retry operation. for ($mailboxCounter ; $mailboxCounter -lt $totalMailboxes ; $mailboxCounter++) { #Drop the mailbox into a working variable. $mailbox = $auditMailboxes[$mailboxCounter] if ($forCounter -gt 1000) { out-logfile -string "Sleeping for 5 seconds - powershell refresh." start-sleep -seconds 5 $forCounter=0 } else { $forCounter++ } out-logfile -string ("Processing mailbox = "+$mailbox.primarySMTPAddress) out-logfile -string ("Processing mailbox number: "+$mailboxCounter.toString()) $MbxNumber++ $progressString = "Mailbox Name: "+$mailbox.primarySMTPAddress+" Mailbox Number: "+$mailboxCounter Write-Progress -Activity "Processing mailbox" -Status $progressString -PercentComplete $PercentComplete -Id 1 $PercentComplete += $ProgressDelta try { $auditFolders=get-exomailboxFolderStatistics -identity $mailbox.identity | where {$_.FolderType -eq "User Created" -or $_.FolderType -eq "Inbox" -or $_.FolderType -eq "SentItems" -or $_.FolderType -eq "Contacts" -or $_.FolderType -eq "Calendar"} } catch { out-logfile -string "Error obtaining folder statistics." out-logfile -string $_ -isError:$TRUE } #Audit folders have been obtained. #For each folder - normalize the folder names. $ProgressDeltaFolders = 100/($auditFolders.count); $PercentCompleteFolders = 0; $FolderNumber = 0 foreach ($folder in $auditFolders) { out-logFile -string ("Processing folder name ="+$folder.Identity) out-logfile -string ("Processing folder = "+$folder.FolderId) out-logfile -string ("Processing cotent mailbox guid = "+$folder.ContentMailboxGuid) $folderNumber++ Write-Progress -Activity "Processing folder" -Status $folder.identity -PercentComplete $PercentCompleteFolders -id 2 -ParentId 1 $PercentCompleteFolders += $ProgressDeltaFolders $tempFolderName=$folder.ContentMailboxGuid.tostring()+":"+$folder.FolderId.tostring() #start-sleep -Seconds 5 #Debug sleep to watch status bar. out-logfile -string ("Temp folder name = "+$tempFolderName) $auditFolderNames+=$tempFolderName } write-progress -activity "Processing Folders" -ParentId 1 -Id 2 -Completed #At this time the folder names have been normalized to mailbox ID and folder ID - this allows us to store them in an object later. out-logfile -string "Obtaining any custom folder permissions that are not default or anonymous." $ProgressDeltaAuditNames = 100/($auditFolderNames.count); $PercentCompleteAuditNames = 0; $FolderNameCount = 0 foreach ($folderName in $auditFolderNames) { if ($forCounter -gt 1000) { out-logfile -string "Sleeping for 5 seconds - powershell refresh." start-sleep -seconds 5 $forCounter=0 } else { $forCounter++ } out-logfile -string ("Obtaining permissions on the following folder = "+$folderName) $FolderNameCount++ Write-Progress -Activity "Processing folder" -Status $folderName -PercentComplete $PercentCompleteAuditNames -parentid 1 -Id 2 $PercentCompleteAuditNames += $ProgressDeltaAuditNames try { $forPermissions = Get-exomailboxFolderPermission -Identity $FolderName -ErrorAction Stop } catch { out-logfile -string "Unable to obtain folder permissions." out-logfile -string $_ -isError:$TRUE } #Check the permissions found to see if they meet the criteria. $ProgressDeltaPermissions = 100/($forPermissions.count); $PercentCompletePermissions = 0; $permissionNumber = 0 foreach ($permission in $forPermissions) { $forUser = $Permission.User.tostring() out-logfile -string ("Found User = "+$forUser) $forNumberr++ Write-Progress -Activity "Processing permission" -Status $permission.identity -PercentComplete $PercentCompletePermissions -parentID 2 -id 3 $PercentCompletePermissions += $ProgressDeltaPermissions #start-sleep -seconds 5 #Debug sleep to watch status bar. if (($forUser -ne "Default") -and ($foruser -ne "Anonymous") -and ($foruser -notLike "NT:S-1-5-21*")) { out-logfile -string ("Not default or anonymous permission = "+$permission.user) $forPermissionObject = New-Object PSObject -Property @{ identity = $permission.identity folderName = $permission.folderName user = $permission.user accessRights = $permission.accessRights } out-logfile -string $forPermissionObject $auditFolderPermissions+=$forPermissionObject $auditPermissionsFound = 1 } } write-progress -activity 'Processing permissions' -ParentId 2 -id 3 -Completed } write-progress "Processing folders" -ParentId 1 -id 2 -Completed #At this time write out the permissions. $fileName = $office365MailboxFolderPermissions $exportFile=Join-path $logFolderPath $fileName $auditFolderPermissions | Export-Clixml -Path $exportFile $fileName = $office365MailboxProcessed $exportFile=Join-path $logFolderPath $fileName $mailboxCounter | export-clixml -path $exportFile #Null out all the arrays for the next run except mailboxes. $auditFolderNames=@() $auditFolders=@() } } |