Skip to content

Get-ContextSetting

SYNOPSIS

Retrieve a setting from a context.

SYNTAX

Get-ContextSetting [-Context] <String> [-Name] <String> [-AsPlainText] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

This function retrieves a setting from a specified context. If the setting is a secret, it can be returned as plain text using the -AsPlainText switch.

EXAMPLES

EXAMPLE 1

Get-ContextSetting -Context 'GitHub' -Name 'APIBaseUri'

Get the value of the 'APIBaseUri' setting from the 'GitHub' context.

PARAMETERS

-Context

The context to get the configuration from.

Type: String
Parameter Sets: (All)
Aliases: ContextName

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

-Name

Name of a setting to get.

Type: String
Parameter Sets: (All)
Aliases:

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

-AsPlainText

Return the setting as plain text if it is a secret.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

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.Object

NOTES