O365UserLicenseReport.ps1


Description

@GitHub Copilot - Welcome @BanterBoy, I’m your Copilot and I’m here to help you get things done faster. I can identify issues, explain and even improve code.

You can ask generic questions, but what I’m really good at is helping you with your code. For example:

Generate unit tests for my code Explain the selected code Propose a fix for the bugs in my code If you want to learn more about my capabilities and limitations, check out the Copilot documentation.

I’m powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve.

@BanterBoy: - Explain what the script does and why it is useful.

@GitHub Copilot -


Script

#Using this script administrator can identify all licensed users with their assigned licenses, services, and its status.
#Connect AzureAD from PowerShell
Connect-MsolService
#Set output file
$ExportCSV = ".\DetailedO365UserLicenseReport_$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv"
$ExportSimpleCSV = ".\SimpleO365UserLicenseReport_$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv"
#FriendlyName list for license plan and service
$FriendlyNameHash = Get-Content -Raw -Path .\LicenseFriendlyName.txt -ErrorAction Stop | ConvertFrom-StringData
$ServiceArray = Get-Content -Path .\ServiceFriendlyName.txt -ErrorAction Stop
#Hash table declaration
$Result = ""
$Results = @()
$output = ""
$outputs = @()
#Get licensed user
$LicensedUserCount = 0
Get-MsolUser -All | Where-Object { $_.islicensed -eq "true" } | Foreach-Object { #User loop
    $LicensedUserCount++
    $LicensePlanWithEnabledService = ""
    $FriendlyNameOfLicensePlanWithService = ""
    $upn = $_.userprincipalname
    Write-Progress -Activity "`n     Exported user count:$LicensedUserCount "`n"Currently Processing:$upn"
    #Get all asssigned SKU for current user
    $Skus = $_.licenses.accountSKUId
    $LicenseCount = $skus.count
    $count = 0
    #Loop through each SKUid
    foreach ($Sku in $Skus) {
        #License loop
        #Convert Skuid to friendly name
        $LicenseItem = $Sku -Split ":" | Select-Object -Last 1
        $EasyName = $FriendlyNameHash[$LicenseItem]
        if (!($EasyName))
        { $NamePrint = $LicenseItem }
        else
        { $NamePrint = $EasyName }
        #Get all services for current SKUId
        $Services = $_.licenses[$count].ServiceStatus
        if (($Count -gt 0) -and ($count -lt $LicenseCount)) {
            $LicensePlanWithEnabledService = $LicensePlanWithEnabledService + ","
            $FriendlyNameOfLicensePlanWithService = $FriendlyNameOfLicensePlanWithService + ","
        }
        $DisabledServiceCount = 0
        $serviceExceptDisabled = ""
        $FriendlyNameOfServiceExceptDisabled = ""
        foreach ($Service in $Services) {
            #Service loop
            $flag = 0
            $ServiceName = $Service.ServicePlan.ServiceName
            if ($service.ProvisioningStatus -eq "Disabled") {
                $DisabledServiceCount++
            }
            else {
                $serviceExceptDisabled = $serviceExceptDisabled + $ServiceName + ","
                $flag = 1
            }
            #Convert ServiceName to friendly name
            for ($i = 0; $i -lt $ServiceArray.length; $i += 2) {
                $ServiceFriendlyName = $ServiceName
                $Condition = $ServiceName -Match $ServiceArray[$i]
                if ($Condition -eq "True") {
                    $ServiceFriendlyName = $ServiceArray[$i + 1]
                    break
                }
            }
            if ($flag -eq 1)
            { $FriendlyNameOfServiceExceptDisabled = $FriendlyNameOfServiceExceptDisabled + $ServiceFriendlyName + "," }
            #Store Service and its status in Hash table
            $Result = @{'DisplayName' = $_.Displayname; 'UserPrinciPalName' = $upn; 'LicensePlan' = $Licenseitem; 'FriendlyNameofLicensePlan' = $nameprint; 'ServiceName' = $service.ServicePlan.ServiceName;
                'FriendlyNameofServiceName' = $serviceFriendlyName; 'ProvisioningStatus' = $service.ProvisioningStatus
            }
            $Results = New-Object PSObject -Property $Result
            $Results | select-object DisplayName, UserPrinciPalName, LicensePlan, FriendlyNameofLicensePlan, ServiceName, FriendlyNameofServiceName,
            ProvisioningStatus | Export-Csv -Path $ExportCSV -Notype -Append
        }
        if ($Disabledservicecount -eq 0) {
            $serviceExceptDisabled = "All services"
            $FriendlyNameOfServiceExceptDisabled = "All services"
        }
        $LicensePlanWithEnabledService = $LicensePlanWithEnabledService + $Licenseitem + "[" + $serviceExceptDisabled + "]"
        $FriendlyNameOfLicensePlanWithService = $FriendlyNameOfLicensePlanWithService + $NamePrint + "[" + $FriendlyNameOfServiceExceptDisabled + "]"
        #Increment SKUid count
        $count++
    }
    $Output = @{'Displayname' = $_.Displayname; 'UserPrincipalName' = $upn;
        'FriendlyNameOfLicensePlanWithService' = $FriendlyNameOfLicensePlanWithService
    }
    $Outputs = New-Object PSObject -Property $output
    $Outputs | Select-Object Displayname, userprincipalname, FriendlyNameOfLicensePlanWithService | Export-Csv -path $ExportSimpleCSV -NoTypeInformation -Append
}
#Open output file after execution
Write-Host Detailed report available in: $ExportCSV
Write-host Simple report available in: $ExportSimpleCSV
$Prompt = New-Object -ComObject wscript.shell
$UserInput = $Prompt.popup("Do you want to open output files?", `
        0, "Open Files", 4)
If ($UserInput -eq 6) {
    Invoke-Item "$ExportCSV"
    Invoke-Item "$ExportSimpleCSV"
}

Back to Top


Download

Please feel free to copy parts of the script or if you would like to download the entire script, simple click the download button. You can download the complete repository in a zip file by clicking the Download link in the menu bar on the left hand side of the page.


Report Issues

You can report an issue or contribute to this site on GitHub. Simply click the button below and add any relevant notes. I will attempt to respond to all issues as soon as possible.

Issue


Back to Top