Skip to content

Remove-ContextSetting

SYNOPSIS

Remove a setting from the context.

SYNTAX

Remove-ContextSetting [-Name] <String> [-Context] <String> [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

This function removes a setting from the specified context. It supports wildcard patterns for the name and does accept pipeline input.

EXAMPLES

EXAMPLE 1

Remove-ContextSetting -Name 'APIBaseUri' -Context 'GitHub'

Remove the APIBaseUri setting from the 'GitHub' context.

EXAMPLE 2

Get-ContextSetting -Context 'GitHub' | Remove-ContextSetting

Remove all settings starting with 'API' from the 'GitHub' context.

EXAMPLE 3

Remove-ContextSetting -Name 'API*' -Context 'GitHub'

Remove all settings starting with 'API' from the 'GitHub' context.

EXAMPLE 4

Get-ContextSetting -Context 'GitHub' | Where-Object { $_.Name -like 'API*' } | Remove-ContextSetting

Remove all settings starting with 'API' from the 'GitHub' context using pipeline input.

PARAMETERS

-Name

Name of a setting to remove.

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

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Context

The name of the context where the setting will be removed.

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

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

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

NOTES