functions/license/Remove-PSFLicense.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
function Remove-PSFLicense
{
<#
 .SYNOPSIS
  Removes a registered license from the license store
  
 .DESCRIPTION
  Removes a registered license from the license store
  
 .PARAMETER License
  The license to remove
  
 .PARAMETER EnableException
  This parameters disables user-friendly warnings and enables the throwing of exceptions.
  This is less user friendly, but allows catching exceptions in calling scripts.
  
 .PARAMETER Confirm
  If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.
 
 .PARAMETER WhatIf
  If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.
  
 .EXAMPLE
  PS C:\> Get-PSFLicense "FooBar" | Remove-PSFLicense
  
  Removes the license for the product "FooBar" from the license store.
#>

    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'Low')]
    Param (
        [Parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [PSFramework.License.License[]]
        $License,
        
        [switch]
        $EnableException
    )
    
    Begin
    {
        
    }
    Process
    {
        foreach ($l in $License)
        {
            if ($PSCmdlet.ShouldProcess("$($l.Product) $($l.ProductVersion) ($($l.LicenseName))", "Remove License"))
            {
                try { [PSFramework.License.LicenseHost]::Remove($l) }
                catch
                {
                    Stop-PSFFunction -Message "Failed to remove license" -ErrorRecord $_ -EnableException $EnableException -Target $l -Continue
                }
            }
        }
    }
    End
    {
        
    }
}