start-upgradeToOffice365Group.ps1
|
<#
.SYNOPSIS This function triggers the upgrade of the group to an Office 365 Modern / Unified Group .DESCRIPTION This function triggers the upgrade of the group to an Office 365 Modern / Unified Group .PARAMETER groupSMTPAddress THe SMTP address of the group to trigger the upgrade on. .OUTPUTS None .EXAMPLE start-upgradeToOffice365Group -groupSMTPAddress address #> Function start-upgradeToOffice365Group { [cmdletbinding()] Param ( [Parameter(Mandatory = $true)] [string]$groupSMTPAddress ) #Output all parameters bound or unbound and their associated values. write-functionParameters -keyArray $MyInvocation.MyCommand.Parameters.Keys -parameterArray $PSBoundParameters -variableArray (Get-Variable -Scope Local -ErrorAction Ignore) [string]$isTestError="No" #Declare function variables. #Start function processing. Out-LogFile -string "********************************************************************************" Out-LogFile -string "BEGIN start-upgradeToOffice365Group" Out-LogFile -string "********************************************************************************" #Call the command to begin the upgrade process. out-logFile -string "Calling command to being the upgrade process." out-logfile -string "NOTE: This command runs in the background and no status is provided." out-logfile -string "Administrators MUST validate the upgrade as successful manually." try{ $attempt=upgrade-o365DistributionGroup -DlIdentities $groupSMTPAddress } catch{ out-logFile -string $_ $isTestError="Yes" } out-logfile -string $attempt out-logfile -string ("Upgrade attempt successfully submitted = "+$attempt.SuccessfullySubmittedForUpgrade) if ($attempt.reason -ne $NULL) { out-logfile -string ("Error Reason = "+$attempt.errorReason) $isTestError="Yes" } Out-LogFile -string "END start-upgradeToOffice365Group" Out-LogFile -string "********************************************************************************" return $isTestError } |