CLA-Assessment

1.7.0

Modules/Providers/ProviderHelpers/LicenseHelper.psm1

function Get-AADLicenseState {
    <#
    .SYNOPSIS
    Returns a simple, robust view of the tenant's license state for Entra ID scenarios.
 
    .DESCRIPTION
    Derives license state from subscribed SKUs/service plans. This avoids relying on
    commerce/billing APIs that are not consistently available via Graph. The goal is to
    give the provider a safe, non-crashing signal for gating optional calls and for
    reporting.
 
    .PARAMETER SubscribedSku
    Array/object returned from Get-MgBetaSubscribedSku (or equivalent Tracker call).
 
    .PARAMETER LicenseWarningDays
    Threshold in days for marking licenses as expiring soon. Currently unused because
    expiration data is not available from the provided inputs. Kept for future extension.
 
    .OUTPUTS
    Hashtable with keys: state, has_any_sku, has_active_plans, is_expired, days_until_expiration,
    is_expiring_soon, state_reason
    #>
    param (
        [Parameter(Mandatory=$false)]
        $SubscribedSku,

        [Parameter(Mandatory=$false)]
        [int]
        $LicenseWarningDays = 30
    )

    $hasAnySku = $false
    $hasActivePlans = $false

    try {
        $hasAnySku = @($SubscribedSku).Count -gt 0
    } catch {
        $hasAnySku = $false
    }

    if ($hasAnySku) {
        try {
            $servicePlans = $SubscribedSku.ServicePlans
            if ($servicePlans) {
                $hasActivePlans = ($servicePlans | Where-Object -Property ProvisioningStatus -eq -Value "Success") | ForEach-Object { $_ } | Measure-Object | Select-Object -ExpandProperty Count
                $hasActivePlans = [bool]($hasActivePlans -gt 0)
            } else {
                $hasActivePlans = $false
            }
        } catch {
            $hasActivePlans = $false
        }
    }

    # Derive state
    $state = "Unknown"
    $reason = "State could not be determined from subscribed SKUs."

    if (-not $hasAnySku) {
        $state = "NoLicense"
        $reason = "No subscribed SKUs were found for the tenant."
    }
    elseif ($hasActivePlans) {
        $state = "Active"
        $reason = "At least one service plan is provisioned successfully."
    }
    else {
        $state = "Inactive"
        $reason = "Subscribed SKUs exist but no service plans are provisioned successfully."
    }

    # Expiration signals are not available from SubscribedSku; keep null/false for now
    $result = @{
        state = $state
        has_any_sku = $hasAnySku
        has_active_plans = $hasActivePlans
        is_expired = ($state -eq "Inactive") # best-effort; may represent disabled/expired/suspended
        days_until_expiration = $null
        is_expiring_soon = $false
        state_reason = $reason
        warning_days_threshold = $LicenseWarningDays
    }

    return $result
}