Private/NestedFunctions/Get-JCUserAgent.ps1

Function Get-JCUserAgent
{
    param(
        [switch]$ShowUserAgent
    )
    # Get information about the module
    If ($MyInvocation.MyCommand.Module)
    {
        $UserAgent_ModuleName = $MyInvocation.MyCommand.Module.Name
        $UserAgent_ModuleVersion = $MyInvocation.MyCommand.Module.Version
    }
    Else
    {
        $ModuleRoot = (Get-Item -Path:($PSScriptRoot)).Parent.Parent.FullName
        $ModulePsd1 = Get-ChildItem -Path:($ModuleRoot) -Filter:('*.psd1')
        If ($ModulePsd1)
        {
            $Psd1Info = Import-LocalizedData -BaseDirectory:($ModulePsd1.Directory) -FileName:($ModulePsd1.Name)
            $UserAgent_ModuleName = $Psd1Info.RootModule.Replace('.psm1', '')
            $UserAgent_ModuleVersion = $Psd1Info.ModuleVersion
        }
        Else
        {
            Write-Error ('Unable to locate the module psd1 file!')
        }
    }
    $UserAgent_ModuleName = 'PSModule_' + $UserAgent_ModuleName
    # Get information about the version of PowerShell
    $UserAgent_PSVersion = [System.String]$PSVersionTable.PSVersion
    $UserAgent_PSEdition = [System.String]$PSVersionTable.PSEdition
    $UserAgent_OS = [System.String]$PSVersionTable.OS
    $UserAgent_Platform = [System.String]$PSVersionTable.Platform
    # Get information about the functions that were used to make the web request
    $UserAgent_PSCallStack = Get-PSCallStack
    $UserAgent_PrimaryFunction = $UserAgent_PSCallStack.Command[-2]
    $UserAgent_NestedFunction = $UserAgent_PSCallStack.Command[1]
    # Get information about who is running the command
    $UserAgent_IS_CUSTOMER = $JCSettings.IS_CUSTOMER
    $UserAgent_ORG_ID = $JCSettings.ORG_ID
    # Build UserAgent string
    # $Template_UserAgent = '{0}/{1} (PSVersion:{2}; PSEdition:{3}; OS:{4}; Platform:{5}; IS_CUSTOMER:{6}; PrimaryFunction:{7}; NestedFunction:{8};)'
    # $CustomUserAgent = $Template_UserAgent -f $UserAgent_ModuleName, $UserAgent_ModuleVersion, $UserAgent_PSVersion, $UserAgent_PSEdition, $UserAgent_OS, $UserAgent_Platform, $UserAgent_IS_CUSTOMER, $UserAgent_PrimaryFunction, $UserAgent_NestedFunction
    $Template_UserAgent = '{0}/{1} (PSVersion:{2}; PSEdition:{3}; ORG_ID:{4}; IS_CUSTOMER:{5}; PrimaryFunction:{6}; NestedFunction:{7};)'
    $CustomUserAgent = $Template_UserAgent -f $UserAgent_ModuleName, $UserAgent_ModuleVersion, $UserAgent_PSVersion, $UserAgent_PSEdition, $UserAgent_ORG_ID, $UserAgent_IS_CUSTOMER, $UserAgent_PrimaryFunction, $UserAgent_NestedFunction
    # Show the UserAgent to the console if parameter is passed in
    if ($PSBoundParameters.ShowUserAgent)
    {
        $CurrentVerbosePreference = $VerbosePreference
        $VerbosePreference = 'Continue'
        Write-Verbose ($CustomUserAgent)
        $VerbosePreference = $CurrentVerbosePreference
    }
    Return $CustomUserAgent
}