Public/Functions/Support/Licensing/Test-TeamsUserHasCallPlan.ps1
|
# Module: TeamsFunctions # Function: Testing # Author: David Eberhardt # Updated: 01-OCT-2020 # Status: Live function Test-TeamsUserHasCallPlan { <# .SYNOPSIS Tests an AzureAD-Object for a CallingPlan License .DESCRIPTION Any assigned Calling Plan found on the User (with exception of the Communication Credits license, which is add-on) will let this function return $TRUE .PARAMETER Identity Mandatory. The sign-in address or User Principal Name of the user account to modify. .EXAMPLE Test-TeamsUserHasCallPlan -Identity User@domain.com -ServicePlan MCOEV Will Return $TRUE only if the ServicePlan is assigned and ProvisioningStatus is SUCCESS! This can be a part of a License. .EXAMPLE Test-TeamsUserHasCallPlan -Identity User@domain.com Will Return $TRUE only if one of the following license Packages are assigned: InternationalCallingPlan, DomesticCallingPlan, DomesticCallingPlan120, DomesticCallingPlan120b .INPUTS System.String .OUTPUTS Boolean .NOTES This Script is indiscriminate against the User Type, all AzureAD User Objects can be tested. .FUNCTIONALITY Returns a boolean value for when any of the Calling Plan licenses are found assigned to a specific user. .COMPONENT SupportingFunction Licensing .FUNCTIONALITY Tests whether the User has a Microsoft Calling Plan License .LINK https://github.com/DEberhardt/TeamsFunctions/tree/master/docs/ .LINK about_SupportingFunction .LINK Test-TeamsUserLicense .LINK Test-TeamsUserHasCallPlan #> [CmdletBinding()] [OutputType([Boolean])] param( [Parameter(Mandatory, Position = 0, ValueFromPipeline, HelpMessage = 'This is the UserID (UPN)')] [Alias('ObjectId', 'Identity')] [string]$UserPrincipalName ) #param begin { Show-FunctionStatus -Level Live Write-Verbose -Message "[BEGIN ] $($MyInvocation.MyCommand)" Write-Verbose -Message "Need help? Online: $global:TeamsFunctionsHelpURLBase$($MyInvocation.MyCommand)`.md" # Asserting AzureAD Connection if (-not (Assert-AzureADConnection)) { break } # Loading License Array if (-not $global:TeamsFunctionsMSAzureAdLicenses) { $global:TeamsFunctionsMSAzureAdLicenses = Get-AzureAdLicense -WarningAction SilentlyContinue } $AllLicenses = $null $AllLicenses = $global:TeamsFunctionsMSAzureAdLicenses } #begin process { Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand)" foreach ($ID in $UserPrincipalName) { # Query User try { $UserObject = Get-AzureADUser -ObjectId "$ID" -WarningAction SilentlyContinue -ErrorAction Stop $UserLicenseObject = Get-AzureADUserLicenseDetail -ObjectId $($UserObject.ObjectId) -WarningAction SilentlyContinue $UserLicenseSKU = $UserLicenseObject.SkuPartNumber } catch { $Message = $_ | Get-ErrorMessageFromErrorString Write-Warning -Message "User '$ID': GetUser$($Message.Split(':')[1])" } $DOM120b = (($AllLicenses | Where-Object ParameterName -EQ DomesticCallingPlan120b).SkuPartNumber -in $UserLicenseSKU) $DOM120 = (($AllLicenses | Where-Object ParameterName -EQ DomesticCallingPlan120).SkuPartNumber -in $UserLicenseSKU) $DOM = (($AllLicenses | Where-Object ParameterName -EQ DomesticCallingPlan).SkuPartNumber -in $UserLicenseSKU) $INT = (($AllLicenses | Where-Object ParameterName -EQ InternationalCallingPlan).SkuPartNumber -in $UserLicenseSKU) if ($INT -or - $DOM -or $DOM120 -or $DOM120b) { return $true } else { return $false } } } #process end { Write-Verbose -Message "[END ] $($MyInvocation.MyCommand)" } #end } #Test-TeamsUserCallPlan |