Skip to content

Get-PodeEnvironmentVariable

SYNOPSIS

Gets an environment variable value.

SYNTAX

Get-PodeEnvironmentVariable [-Name] <String> [[-Target] <EnvironmentVariableTarget>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Gets an environment variable value from the specified target (Process, User, or Machine).

EXAMPLES

EXAMPLE 1

$envValue = Get-PodeEnvironmentVariable -Name 'PATH'

EXAMPLE 2

$envValue = Get-PodeEnvironmentVariable -Name 'MY_VAR' -Target 'User'

PARAMETERS

-Name

The name of the environment variable to retrieve.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Target

The target scope from which to retrieve the environment variable. Default is Process.

Type: EnvironmentVariableTarget
Parameter Sets: (All)
Aliases:
Accepted values: Process, User, Machine

Required: False
Position: 2
Default value: Process
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.String

NOTES