functions/remove-axenvironmentconfig.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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

<#
    .SYNOPSIS
        Remove environment configuration
         
    .DESCRIPTION
        Remove a environment configuration from the configuration store
         
    .PARAMETER Name
        Name of the environment configuration you want to remove from the configuration store
         
    .PARAMETER Temporary
        Instruct the cmdlet to only temporarily remove the environment configuration from the configuration store
         
    .EXAMPLE
        PS C:\> Remove-AxEnvironmentConfig -Name "UAT"
         
        This will remove the environment configuration name "UAT" from the machine.
         
    .NOTES
        Tags: Servicing, Environment, Config, Configuration, Servers
         
        Author: Mötz Jensen (@Splaxi)
         
    .LINK
        Add-AxEnvironmentConfig
         
    .LINK
        Clear-AxActiveEnvironmentConfig
         
    .LINK
        Get-AxActiveEnvironmentConfig
         
    .LINK
        Get-AxEnvironmentConfig
         
    .LINK
        Set-AxActiveEnvironmentConfig
         
#>


function Remove-AxEnvironmentConfig {
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
    [CmdletBinding()]
    [OutputType()]
    param (
        [Parameter(Mandatory = $true, Position = 1)]
        [string] $Name,

        [switch] $Temporary
    )

    $Name = $Name.ToLower()

    if ($Name -match '\*') {
        Write-PSFMessage -Level Host -Message "The name cannot contain <c='em'>wildcard character</c>."
        Stop-PSFFunction -Message "Stopping because the name contains wildcard character."
        return
    }

    if (-not ((Get-PSFConfig -FullName "ax2012.tools.environment.*.name").Value -contains $Name)) {
        Write-PSFMessage -Level Host -Message "A environment configuration with that name <c='em'>doesn't exists</c>."
        Stop-PSFFunction -Message "Stopping because a environment message configuration with that name doesn't exists."
        return
    }

    $res = (Get-PSFConfig -FullName "ax2012.tools.environment.config.name").Value

    if ($res -eq $Name) {
        Write-PSFMessage -Level Host -Message "The active environment configuration is the <c='em'>same as the one you're trying to remove</c>. Please set another configuration as active, before removing this one. You could also call Clear-AxActiveEnvironmentConfig."
        Stop-PSFFunction -Message "Stopping because the active environment configuration is the same as the one trying to be removed."
        return
    }

    foreach ($config in Get-PSFConfig -FullName "ax2012.tools.environment.$Name.*") {
        Set-PSFConfig -FullName $config.FullName -Value ""

        if (-not $Temporary) { Unregister-PSFConfig -FullName $config.FullName -Scope UserDefault }
    }
}