Public/Licensing/Get-AzureAdUserLicenseServicePlan.ps1
|
# Module: TeamsFunctions # Function: Licensing # Author: David Eberhardt # Updated: 01-APR-2020 # Status: Live function Get-AzureAdUserLicenseServicePlan { <# .SYNOPSIS Returns License information (ServicePlans) for an Object in AzureAD .DESCRIPTION Returns an Object containing all ServicePlans (for Licenses assigned) for a specific Object .PARAMETER UserPrincipalname The UserPrincipalname or ObjectId of the Object. .PARAMETER FilterRelevantForTeams Filters the output and displays only Licenses relevant Teams Service Plans .PARAMETER FilterUnsuccessful Filters the output and displays only ServicePlans that don't have the ProvisioningStatus "Success" .EXAMPLE Get-AzureAdUserLicenseServicePlan [-UserPrincipalname] John@domain.com Displays all Service Plans assigned through Licenses to User John@domain.com .EXAMPLE Get-AzureAdUserLicenseServicePlan -UserPrincipalname John@domain.com,Jane@domain.com Displays all Service Plans assigned through Licenses to Users John@domain.com and Jane@domain.com .EXAMPLE Get-AzureAdUserLicenseServicePlan -UserPrincipalname Jane@domain.com -FilterRelevantForTeams Displays all relevant Teams Service Plans assigned through Licenses to Jane@domain.com .EXAMPLE Get-AzureAdUserLicenseServicePlan -UserPrincipalname Jane@domain.com -FilterUnsuccessful Displays all Service Plans assigned through Licenses to Jane@domain.com that are not provisioned successfully .EXAMPLE Import-Csv User.csv | Get-AzureAdUserLicenseServicePlan Displays all Service Plans assigned through Licenses to Users from User.csv, Column UserPrincipalname, ObjectId or Identity. The input file must have a single column heading of "UserPrincipalname" with properly formatted UPNs. .INPUTS System.String .OUTPUTS System.Object .NOTES Requires a connection to Azure Active Directory .COMPONENT Licensing .FUNCTIONALITY Returns a list of Licenses assigned to a specific User depending on input .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/Get-AzureAdUserLicenseServicePlan.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/about_Licensing.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/about_UserManagement.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/ #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidGlobalVars', '', Justification = 'Required for performance. Removed with Disconnect-Me')] [CmdletBinding()] [OutputType([PSCustomObject])] param( [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName, HelpMessage = 'Enter the UPN or login name of the user account, typically <user>@<domain>.')] [Alias('ObjectId', 'Identity')] [ValidateScript( { If ($_ -match '@' -or $_ -match $script:TFMatchGuid) { $True } else { throw [System.Management.Automation.ValidationMetadataException] 'Value must be a valid UPN or ObjectId' } })] [string[]]$UserPrincipalName, [Parameter(HelpMessage = 'Displays only Service Plans relevant to Teams')] [switch]$FilterRelevantForTeams, [Parameter(HelpMessage = 'Displays only Service Plans that are not successfully provisioned')] [switch]$FilterUnsuccessful ) #param begin { Show-FunctionStatus -Level Live $Stack = Get-PSCallStack $Called = ($stack.length -ge 3) Write-Verbose -Message "[BEGIN ] $($MyInvocation.MyCommand)" # Asserting AzureAD Connection if ( -not $script:TFPSSA) { $script:TFPSSA = Assert-AzureADConnection; if ( -not $script:TFPSSA ) { break } } # Setting Preference Variables according to Upstream settings if (-not $PSBoundParameters.ContainsKey('Verbose')) { $VerbosePreference = $PSCmdlet.SessionState.PSVariable.GetValue('VerbosePreference') } if (-not $PSBoundParameters.ContainsKey('Confirm')) { $ConfirmPreference = $PSCmdlet.SessionState.PSVariable.GetValue('ConfirmPreference') } if (-not $PSBoundParameters.ContainsKey('WhatIf')) { $WhatIfPreference = $PSCmdlet.SessionState.PSVariable.GetValue('WhatIfPreference') } if (-not $PSBoundParameters.ContainsKey('Debug')) { $DebugPreference = $PSCmdlet.SessionState.PSVariable.GetValue('DebugPreference') } else { $DebugPreference = 'Continue' } if ( $PSBoundParameters.ContainsKey('InformationAction')) { $InformationPreference = $PSCmdlet.SessionState.PSVariable.GetValue('InformationAction') } else { $InformationPreference = 'Continue' } # preparing Output Field Separator $OFS = ', ' # do not remove - Automatic variable, used to separate elements! } #begin process { Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand)" foreach ($User in $UserPrincipalName) { try { $UserObject = $null $UserLicenseDetail = $null #New Graph Equivalent to be rolled out through Refactor in Orbit #$UserObject = Get-MgUserLicenseDetail -UserId "$User" -WarningAction SilentlyContinue -ErrorAction STOP $UserObject = Get-AzureADUser -ObjectId "$User" -WarningAction SilentlyContinue -ErrorAction STOP #New Graph Equivalent to be rolled out through Refactor in Orbit #$UserLicenseDetail = Get-MgUserLicenseDetail -UserId "$User" -WarningAction SilentlyContinue -ErrorAction STOP $UserLicenseDetail = Get-AzureADUserLicenseDetail -ObjectId "$User" -WarningAction SilentlyContinue -ErrorAction STOP } catch { #Write-Error -Message "Error ocurred for User '$User': $($_.Exception.Message)" -Category InvalidResult throw $_ continue } [string]$DisplayName = $UserObject.DisplayName if ( $UserLicenseDetail ) { # Querying Service Plans $UserServicePlans = Get-UserServicePlansFromLicenseDetailObject -UserLicenseDetail $UserLicenseDetail @args } # Filter if ( $FilterRelevantForTeams.IsPresent ) { $UserServicePlans = $UserServicePlans | Where-Object RelevantForTeams } if ( $FilterUnsuccessful.IsPresent ) { $UserServicePlans = $UserServicePlans | Where-Object ProvisioningStatus -EQ 'Success' } # Output Write-Information "INFO: User '$User' - Service Plans for User '$DisplayName':" Write-Output $UserServicePlans } } #process end { Write-Verbose -Message "[END ] $($MyInvocation.MyCommand)" } #end } #Get-AzureAdUserLicenseServicePlan |