PSRyver

0.0.8

Public/Get-PSRyverConfig.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
 function Get-PSRyverConfig {
    <#
    .SYNOPSIS
        Get the PSRyver module configuration.
 
    .DESCRIPTION
        Get the PSRyver module configuration stored in the $Script:PSRyver variable.
 
    .INPUTS
        None
            You cannot pipe input to this cmdlet.
 
    .NOTES
        - Troy Lindsay
        - Twitter: @troylindsay42
        - GitHub: tlindsay42
 
    .EXAMPLE
        Get-PSRyverConfig
        Returns the value of the $Script:PSRyver module configuration variable.
 
    .LINK
        https://tlindsay42.github.io/PSRyver/Public/Get-PSRyverConfig/
 
    .LINK
        https://github.com/tlindsay42/PSRyver/blob/master/PSRyver/Public/Get-PSRyverConfig.ps1
 
    .LINK
        Set-PSRyverConfig
 
    .LINK
        Initialize-PSRyverConfig
 
    .LINK
        Remove-PSRyverConfig
 
    .FUNCTIONALITY
        Ryver
    #>
    [CmdletBinding(
        HelpUri = 'https://tlindsay42.github.io/PSRyver/Public/Get-PSRyverConfig/'
    )]
    [OutputType( [PSCustomObject] )]
    param ()

    begin {
        $function = $MyInvocation.MyCommand.Name
        Write-Verbose -Message "Beginning: '${function}'."
    }

    process {
        Write-Verbose -Message (
            "Processing: '${function}' with ParameterSetName '$( $PSCmdlet.ParameterSetName )' and Parameters: " +
            ( $PSBoundParameters | Remove-SensitiveData | Format-Table -AutoSize | Out-String )
        )

        $Script:PSRyver
    }

    end {
        Write-Verbose -Message "Ending: '${function}'."
    }
}