Public/Functions/Licensing/Get-TeamsTenantLicense.ps1
|
# Module: TeamsFunctions # Function: Licensing # Author: David Eberhardt # Updated: 01-OCT-2020 # Status: Live function Get-TeamsTenantLicense { <# .SYNOPSIS Returns one or all Teams Tenant licenses from a Tenant .DESCRIPTION Returns an Object containing Teams related Licenses found in the Tenant Teams services can be provisioned through several different combinations of individual plans as well as add-on and grouped license SKUs. This command displays these license SKUs in a more friendly format with descriptive names, SkuPartNumber, active, consumed, remaining, and expiring licenses. .PARAMETER License Optional. Limits the Output to one license. Accepted Values can be retrieved with Get-AzureAdLicense (Column ParameterName) .PARAMETER Detailed Displays all Parameters. By default, only Parameters relevant to determine License availability are shown. .PARAMETER DisplayAll Displays all Licenses, not only relevant Teams Licenses .EXAMPLE Get-TeamsTenantLicense Displays detailed information about all Teams related licenses found on the tenant. .EXAMPLE Get-TeamsTenantLicense -License PhoneSystem Displays detailed information about the PhoneSystem license found on the tenant. .EXAMPLE Get-TeamsTenantLicense -ConciseView Displays all Teams Licenses found on the tenant, but only Name and counters. .EXAMPLE Get-TeamsTenantLicense -DisplayAll Displays detailed information about all licenses found on the tenant. .EXAMPLE Get-TeamsTenantLicense -ConciseView -DisplayAll Displays a concise view of all licenses found on the tenant. .INPUTS System.String .OUTPUTS System.Object .NOTES Requires a connection to Azure Active Directory .COMPONENT Licensing .FUNCTIONALITY Returns a list of Licenses on the Tenant depending on input .LINK https://github.com/DEberhardt/TeamsFunctions/tree/master/docs/ .LINK about_Licensing .LINK about_UserManagement .LINK Get-TeamsTenantLicense .LINK Get-TeamsUserLicense .LINK Get-TeamsUserLicenseServicePlan .LINK Set-TeamsUserLicense .LINK Test-TeamsUserLicense .LINK Get-AzureAdLicense .LINK Get-AzureAdLicenseServicePlan #> [CmdletBinding()] [Alias('Get-TeamsTenantLicence')] [OutputType([Object[]])] param( [Parameter(Mandatory = $false, HelpMessage = 'Displays all Parameters')] [switch]$Detailed, [Parameter(Mandatory = $false, HelpMessage = 'Displays all ServicePlans')] [switch]$DisplayAll, [Parameter(Mandatory = $false, HelpMessage = 'License to be queried from the Tenant')] [ValidateScript( { $LicenseParams = (Get-AzureAdLicense -WarningAction SilentlyContinue -ErrorAction SilentlyContinue).ParameterName.Split('', [System.StringSplitOptions]::RemoveEmptyEntries) if ($_ -in $LicenseParams) { return $true } else { Write-Host "Parameter 'License' - Invalid license string. Supported Parameternames can be found with Get-AzureAdLicense" -ForegroundColor Red return $false } })] [string]$License ) #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 } # 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' } #Loading License Array if (-not $global:TeamsFunctionsMSAzureAdLicenses) { $global:TeamsFunctionsMSAzureAdLicenses = Get-AzureAdLicense -WarningAction SilentlyContinue } $AllLicenses = $null $AllLicenses = $global:TeamsFunctionsMSAzureAdLicenses $AllLicenses | Add-Member -NotePropertyName Available -NotePropertyValue 0 -Force $AllLicenses | Add-Member -NotePropertyName Consumed -NotePropertyValue 0 -Force $AllLicenses | Add-Member -NotePropertyName Remaining -NotePropertyValue 0 -Force $AllLicenses | Add-Member -NotePropertyName Expiring -NotePropertyValue 0 -Force try { if ($PSBoundParameters.ContainsKey('License')) { $SkuPartNumber = ($AllLicenses | Where-Object ParameterName -EQ $License).SkuPartNumber $tenantSKUs = Get-AzureADSubscribedSku | Where-Object SkuPartNumber -EQ $SkuPartNumber -ErrorAction STOP } else { $tenantSKUs = Get-AzureADSubscribedSku -ErrorAction STOP } } catch { Write-Warning $_ return } } #begin process { Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand)" [System.Collections.ArrayList]$TenantLicenses = @() foreach ($tenantSKU in $tenantSKUs) { $Lic = $null $Lic = $AllLicenses | Where-Object SkuPartNumber -EQ "$($tenantSKU.SkuPartNumber)" if ($PSBoundParameters.ContainsKey('Debug')) { "Function: $($MyInvocation.MyCommand.Name): SkuPartNumber: $($tenantSKU.SkuPartNumber)" | Write-Debug "Function: $($MyInvocation.MyCommand.Name): tenantSKU", $tenantSKU | Write-Debug } #VALIDATE segmentation: Available = Enabled + Warning?; understand Suspended $LicUnitsAvailable = $tenantSKU.PrepaidUnits.Enabled + $tenantSKU.PrepaidUnits.Warning # + $tenantSKU.PrepaidUnits.Suspended # Omitted Suspended ones for now $LicUnitsConsumed = $tenantSKU.ConsumedUnits $LicUnitsRemaining = $LicUnitsAvailable - $LicUnitsConsumed $LicUnitsExpiring = $tenantSKU.PrepaidUnits.Warning if ($null -ne $Lic) { $Lic | Add-Member -NotePropertyName Available -NotePropertyValue $LicUnitsAvailable -Force $Lic | Add-Member -NotePropertyName Consumed -NotePropertyValue $LicUnitsConsumed -Force $Lic | Add-Member -NotePropertyName Remaining -NotePropertyValue $LicUnitsRemaining -Force $Lic | Add-Member -NotePropertyName Expiring -NotePropertyValue $LicUnitsExpiring -Force [void]$TenantLicenses.Add($Lic) } else { if ($PSBoundParameters.ContainsKey('DisplayAll')) { $NewLic = [PSCustomObject][ordered]@{ ProductName = 'Unknown' SkuPartNumber = $tenantSKU.SkuPartNumber LicenseType = 'Unknown' ParameterName = $null IncludesTeams = $null IncludesPhoneSystem = $null SkuId = $tenantSKU.SkuId ServicePlans = 'Unknown' Available = $LicUnitsAvailable Consumed = $LicUnitsConsumed Remaining = $LicUnitsRemaining Expiring = $LicUnitsExpiring } [void]$TenantLicenses.Add($NewLic) } else { if (!$PSBoundParameters.ContainsKey('Detailed')) { Write-Verbose "No entry found for '$($tenantSKU.SkuId)'" } } } } # Output if ($PSBoundParameters.ContainsKey('Detailed')) { Write-Output $TenantLicenses | Sort-Object ProductName } else { Write-Output $TenantLicenses | Sort-Object ProductName | Select-Object ProductName, SkuPartNumber, LicenseType, Available, Consumed, Remaining, Expiring } } #process end { Write-Verbose -Message "[END ] $($MyInvocation.MyCommand)" } #end } #Get-TeamsTenantLicense |