functions/Get-PpacTenantCapacity.ps1
|
<# .SYNOPSIS Get tenant capacity totals. .DESCRIPTION Retrieves Power Platform tenant capacity, including base, incremental, and add-on totals with consumption and backing licenses. .PARAMETER CapacityType Type filter. Wildcards plus Ppac, Dataverse, FinOps, M365, Trial, SubscriptionTrial. Default: * .PARAMETER Full Emits one row per backing license. .PARAMETER AsExcelOutput Instructs the cmdlet to output the results as an Excel file. .EXAMPLE PS C:\> Get-PpacTenantCapacity Lists every tenant capacity type. .EXAMPLE PS C:\> Get-PpacTenantCapacity -CapacityType "Database" Shows the Database capacity totals. It uses -CapacityType to select the Database type. .EXAMPLE PS C:\> Get-PpacTenantCapacity -CapacityType Ppac Shows the Dataverse capacity totals. It uses -CapacityType to select the Ppac alias. .EXAMPLE PS C:\> Get-PpacTenantCapacity -CapacityType FinOps Shows FinOps capacity types only. It uses -CapacityType to select the FinOps alias. .EXAMPLE PS C:\> Get-PpacTenantCapacity -Full Lists one row per backing license. It uses -Full to expand license rows. .EXAMPLE PS C:\> Get-PpacTenantCapacity -CapacityType "Api*" Shows PPR and computed AOS tier rows. It uses -CapacityType to select ApiCallCount and ApiCallCountAos. .EXAMPLE PS C:\> Get-PpacTenantCapacity -AsExcelOutput Exports tenant capacities to an Excel workbook. It uses -AsExcelOutput to write an Excel file. .NOTES Author: d365bap.tools contributors .LINK https://github.com/d365collaborative/d365bap.tools/wiki/AOS-Capacity-Math #> function Get-PpacTenantCapacity { [CmdletBinding()] [OutputType('D365Bap.Tools.PpacTenantCapacity[]', 'D365Bap.Tools.PpacTenantCapacityLicense[]', [object[]])] param ( [Parameter(ValueFromPipelineByPropertyName = $true)] [SupportsWildcards()] [ValidateNotNullOrEmpty()] [string[]] $CapacityType = '*', [switch] $Full, [switch] $AsExcelOutput ) begin { $objSecureToken = Get-BapAccessToken -PowerPlatform $tokenValue = ConvertFrom-SecureString -AsPlainText ` -SecureString $objSecureToken $apiVersion = $script:BapApiVersions.PowerPlatform $hashHeaders = @{ Authorization = "Bearer $tokenValue" } } process { if (Test-PSFFunctionInterrupt) { return } $requestUri = 'https://api.powerplatform.com/licensing/tenantCapacity?api-version={0}' ` -f $apiVersion try { $objPayload = Invoke-RestMethod ` -Method Get ` -Uri $requestUri ` -Headers $hashHeaders 4> $null } catch { $messageString = "Failed retrieving tenant capacity. $($_.Exception.Message)" Write-PSFMessage -Level Important ` -Message $messageString ` -Exception $_.Exception Stop-PSFFunction -Message 'Stopping because the tenant capacity request failed.' ` -Exception $_.Exception return } if ($null -eq $objPayload) { return } $tenantId = $objPayload.tenantId $colPayloadCapacities = @( $objPayload.tenantCapacities | Where-Object { $_ } ) $colKnownTypes = @( $colPayloadCapacities | ForEach-Object { $_.capacityType } | Where-Object { $_ } | Sort-Object -Unique ) if ($colPayloadCapacities.capacityType -contains 'ApiCallCount') { $colKnownTypes = @( $colKnownTypes + @('ApiCallCountAos') | Sort-Object -Unique ) } $hashCapacityAliases = @{ 'Ppac' = @('Database', 'File', 'Log', 'CapacityPass', 'ApiCallCount') 'Dataverse' = @('Database', 'File', 'Log', 'CapacityPass', 'ApiCallCount') 'FinOps' = @('FinOps*') 'M365' = @('M365*') 'Trial' = @('Trial*') 'SubscriptionTrial' = @('SubscriptionTrial*') } $colExpandedPatterns = @( foreach ($itemPattern in $CapacityType) { $tmpAliasKeys = @( $hashCapacityAliases.Keys | Where-Object { $_ -ieq $itemPattern } ) $tmpAliasKey = $tmpAliasKeys | Select-Object -First 1 if ($tmpAliasKey) { foreach ($itemExpanded in $hashCapacityAliases[$tmpAliasKey]) { $itemExpanded } } else { $itemPattern } } ) $colTargetTypes = @( foreach ($itemPattern in $colExpandedPatterns) { if ([Management.Automation.WildcardPattern]::ContainsWildcardCharacters($itemPattern)) { $tmpMatchedTypes = @( $colKnownTypes | Where-Object { $_ -like $itemPattern } ) if ($tmpMatchedTypes.Count -eq 0) { $messageString = "No tenant capacity matches pattern '<c='em'>$itemPattern</c>'. Skipping." Write-PSFMessage -Level Warning ` -Message $messageString } foreach ($itemMatchedType in $tmpMatchedTypes) { $itemMatchedType } } else { if ($itemPattern -in $colKnownTypes) { $itemPattern } else { $messageString = "No tenant capacity found for '<c='em'>$itemPattern</c>'. Skipping." Write-PSFMessage -Level Warning ` -Message $messageString } } } ) $colTargetTypes = @( $colTargetTypes | Sort-Object -Unique ) $colCapacities = @( $colPayloadCapacities | Where-Object { $_.capacityType -in $colTargetTypes } ) $colSummaryRows = @( foreach ($itemCapacity in $colCapacities) { $tmpEntitlements = @( $itemCapacity.capacityEntitlements | Where-Object { $_ } ) $tmpLicenseCount = 0 foreach ($itemCountEntitlement in $tmpEntitlements) { $tmpCountLicenses = @( $itemCountEntitlement.licenses | Where-Object { $_ } ).Count $tmpLicenseCount += $tmpCountLicenses } $tmpBaseSum = @( $tmpEntitlements | Where-Object { $_.capacitySubType -like '*Base' } ) | Measure-Object ` -Property totalCapacity ` -Sum $tmpBaseCapacity = [double]$tmpBaseSum.Sum $tmpIncrementalSum = @( $tmpEntitlements | Where-Object { $_.capacitySubType -like '*Incremental' } ) | Measure-Object ` -Property totalCapacity ` -Sum $tmpIncrementalCapacity = [double]$tmpIncrementalSum.Sum $tmpAddOnSum = @( $tmpEntitlements | Where-Object { $_.capacitySubType -like '*AddOn' } ) | Measure-Object ` -Property totalCapacity ` -Sum $tmpAddOnCapacity = [double]$tmpAddOnSum.Sum $tmpTotalCapacity = $itemCapacity.totalCapacity $tmpConsumed = $itemCapacity.consumption.rated $tmpStatus = $null if ((-Not ($null -eq $tmpTotalCapacity)) ` -and (-Not ($null -eq $tmpConsumed))) { if (($tmpTotalCapacity - $tmpConsumed) -lt 0) { $tmpStatus = 'Overage' } else { $tmpStatus = 'WithinCapacity' } } $itemCapacity | Select-PSFObject -TypeName 'D365Bap.Tools.PpacTenantCapacity' ` -Property @{ Name = 'PpacTenantId'; Expression = { $tenantId } }, 'capacityType as CapacityType', 'capacityUnits as Units', 'totalCapacity as Entitled', @{ Name = 'Consumed'; Expression = { $tmpConsumed } }, 'maxCapacity as MaxCapacity', @{ Name = 'Status'; Expression = { $tmpStatus } }, @{ Name = 'BaseCapacity'; Expression = { $tmpBaseCapacity } }, @{ Name = 'IncrementalCapacity'; Expression = { $tmpIncrementalCapacity } }, @{ Name = 'AddOnCapacity'; Expression = { $tmpAddOnCapacity } }, @{ Name = 'Entitlement'; Expression = { $tmpEntitlements.Count } }, @{ Name = 'Licenses'; Expression = { $tmpLicenseCount } }, @{ Name = 'Raw'; Expression = { $itemCapacity } } } ) $objApiCapacity = $colPayloadCapacities | Where-Object { $_.capacityType -eq 'ApiCallCount' } | Select-Object -First 1 if ((-Not ($null -eq $objApiCapacity)) ` -and ('ApiCallCountAos' -in $colTargetTypes)) { $apiTotal = $objApiCapacity.totalCapacity if ($null -eq $apiTotal) { $apiTotal = 0 } $perAos = 650000 $minAos = 2 $maxAos = 80 $currentAos = [int][Math]::Floor($apiTotal / $perAos) if ($currentAos -lt $minAos) { $currentAos = $minAos } if ($currentAos -gt $maxAos) { $currentAos = $maxAos } $intoCurrentTier = $apiTotal - $currentAos * $perAos if ($intoCurrentTier -lt 0) { $intoCurrentTier = 0 } $toNextAos = ($currentAos + 1) * $perAos - $apiTotal $headroomToMax = $maxAos * $perAos - $apiTotal $aosStatus = 'WithinCapacity' if (($maxAos - $currentAos) -lt 0) { $aosStatus = 'Overage' } $objAosRow = $objApiCapacity | Select-PSFObject -TypeName 'D365Bap.Tools.PpacTenantCapacity' ` -Property @{ Name = 'PpacTenantId'; Expression = { $tenantId } }, @{ Name = 'CapacityType'; Expression = { 'ApiCallCountAos' } }, @{ Name = 'Units'; Expression = { 'AOS' } }, @{ Name = 'Entitled'; Expression = { $maxAos } }, @{ Name = 'Consumed'; Expression = { $currentAos } }, @{ Name = 'MaxCapacity'; Expression = { $null } }, @{ Name = 'Status'; Expression = { $aosStatus } }, @{ Name = 'BaseCapacity'; Expression = { $minAos } }, @{ Name = 'IncrementalCapacity'; Expression = { $currentAos - $minAos } }, @{ Name = 'AddOnCapacity'; Expression = { 0 } }, @{ Name = 'Entitlement'; Expression = { 0 } }, @{ Name = 'Licenses'; Expression = { 0 } }, @{ Name = 'ApiCallTotal'; Expression = { $apiTotal } }, @{ Name = 'PerAos'; Expression = { $perAos } }, @{ Name = 'MinAos'; Expression = { $minAos } }, @{ Name = 'MaxAos'; Expression = { $maxAos } }, @{ Name = 'CurrentAos'; Expression = { $currentAos } }, @{ Name = 'IntoCurrentTier'; Expression = { $intoCurrentTier } }, @{ Name = 'ToNextAos'; Expression = { $toNextAos } }, @{ Name = 'HeadroomToMax'; Expression = { $headroomToMax } }, @{ Name = 'Raw'; Expression = { $objApiCapacity } } $colSummaryRows = @( foreach ($itemRow in $colSummaryRows) { $itemRow if ($itemRow.CapacityType -eq 'ApiCallCount') { $objAosRow } } ) if ($colSummaryRows.CapacityType -notcontains 'ApiCallCount') { $colSummaryRows = @($colSummaryRows) + @($objAosRow) } } if ($Full) { $colRes = @( foreach ($itemLicenseCapacity in $colCapacities) { $tmpLicenseEntitlements = @( $itemLicenseCapacity.capacityEntitlements | Where-Object { $_ } ) foreach ($itemEntitlement in $tmpLicenseEntitlements) { $tmpEntLicenses = @( $itemEntitlement.licenses | Where-Object { $_ } ) foreach ($itemLicense in $tmpEntLicenses) { $tmpNextLifecycleDate = $itemLicense.nextLifecycleDate if (($tmpNextLifecycleDate -is [datetime]) ` -and ($tmpNextLifecycleDate.Year -eq 1)) { $tmpNextLifecycleDate = $null } $tmpTemporaryExpiry = $itemLicense.temporaryLicenseExpiryDate if (($tmpTemporaryExpiry -is [datetime]) ` -and ($tmpTemporaryExpiry.Year -eq 1)) { $tmpTemporaryExpiry = $null } $itemLicense | Select-PSFObject -TypeName 'D365Bap.Tools.PpacTenantCapacityLicense' ` -Property @{ Name = 'PpacTenantId'; Expression = { $tenantId } }, @{ Name = 'CapacityType'; Expression = { $itemLicenseCapacity.capacityType } }, @{ Name = 'CapacitySubType'; Expression = { $itemEntitlement.capacitySubType } }, 'entitlementCode as EntitlementCode', 'displayName as DisplayName', 'servicePlanId as ServicePlanId', 'skuId as SkuId', @{ Name = 'PaidEnabled'; Expression = { $itemLicense.paid.enabled } }, @{ Name = 'PaidWarning'; Expression = { $itemLicense.paid.warning } }, @{ Name = 'PaidSuspended'; Expression = { $itemLicense.paid.suspended } }, @{ Name = 'TrialEnabled'; Expression = { $itemLicense.trial.enabled } }, @{ Name = 'TrialWarning'; Expression = { $itemLicense.trial.warning } }, @{ Name = 'TrialSuspended'; Expression = { $itemLicense.trial.suspended } }, 'totalCapacity as LicenseTotalCapacity', @{ Name = 'NextLifecycleDate'; Expression = { $tmpNextLifecycleDate } }, 'isTemporaryLicense as IsTemporaryLicense', @{ Name = 'TemporaryLicenseExpiryDate'; Expression = { $tmpTemporaryExpiry } }, 'capabilityStatus as CapabilityStatus', @{ Name = 'Raw'; Expression = { $itemLicense } } } } } ) } else { $colRes = $colSummaryRows } if ($AsExcelOutput) { $colRes | Export-Excel -WorksheetName 'Get-PpacTenantCapacity' ` -WarningAction SilentlyContinue return } $colRes } end { } } |