functions/configuration/Get-PSFConfig.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
function Get-PSFConfig
{
    <#
  .SYNOPSIS
   Retrieves configuration elements by name.
   
  .DESCRIPTION
   Retrieves configuration elements by name.
   Can be used to search the existing configuration list.
  
  .PARAMETER FullName
   Default: "*"
   Search for configurations using the full name
   
  .PARAMETER Name
   Default: "*"
   The name of the configuration element(s) to retrieve.
   May be any string, supports wildcards.
   
  .PARAMETER Module
   Default: "*"
   Search configuration by module.
   
  .PARAMETER Force
   Overrides the default behavior and also displays hidden configuration values.
   
  .EXAMPLE
   PS C:\> Get-PSFConfig 'Mail.To'
    
   Retrieves the configuration element for the key "Mail.To"
  
  .EXAMPLE
   PS C:\> Get-PSFConfig -Force
  
   Retrieve all configuration elements from all modules, even hidden ones.
    #>

    [CmdletBinding(DefaultParameterSetName = "FullName")]
    Param (
        [Parameter(ParameterSetName = "FullName", Position = 0)]
        [string]
        $FullName = "*",
        
        [Parameter(ParameterSetName = "Module", Position = 1)]
        [string]
        $Name = "*",
        
        [Parameter(ParameterSetName = "Module", Position = 0)]
        [string]
        $Module = "*",
        
        [switch]
        $Force
    )
    
    switch ($PSCmdlet.ParameterSetName)
    {
        "Module"
        {
            $Name = $Name.ToLower()
            $Module = $Module.ToLower()
            
            [PSFramework.Configuration.ConfigurationHost]::Configurations.Values | Where-Object { ($_.Name -like $Name) -and ($_.Module -like $Module) -and ((-not $_.Hidden) -or ($Force)) } | Sort-Object Module, Name
        }
        
        "FullName"
        {
            [PSFramework.Configuration.ConfigurationHost]::Configurations.Values | Where-Object { ("$($_.Module).$($_.Name)" -like $FullName) -and ((-not $_.Hidden) -or ($Force)) } | Sort-Object Module, Name
        }
    }
}