< Back

Remove-MSTerminalProfile

Sat Jan 18, 2020 4:52 pm

NAME Remove-MSTerminalProfile



SYNOPSIS

Removes a MS Terminal profile





SYNTAX

Remove-MSTerminalProfile [-Confirm] -InputObject <Object> [-WhatIf] [<CommonParameters>]



Remove-MSTerminalProfile [-Confirm] -Name <String> [-WhatIf] [<CommonParameters>]





DESCRIPTION

Removes a MS Terminal profile





PARAMETERS

-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-InputObject <Object>

A MS Terminal profile object from Get-MSTerminalProfile



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Name <String>

The name of the profile(s) to remove.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.Object







OUTPUTS

None







NOTES









-------------------------- Example 1 --------------------------



PS C:\\> Remove-MSTerminalProfile -name pwsh



Removes any terminal profiles with the name "pwsh"

-------------------------- Example 2 --------------------------



PS C:\\> Get-MSTerminalProfile -Name pwsh | Remove-MSTerminalProfile



Removes any terminal profiles with the name "pwsh"



RELATED LINKS