Skip to content

Remove-Alias.md

Latest commit

 

History

History
159 lines (109 loc) · 4.09 KB

Remove-Alias.md

File metadata and controls

159 lines (109 loc) · 4.09 KB
external help file Microsoft.PowerShell.Commands.Utility.dll-Help.xml
Locale en-US
Module Name Microsoft.PowerShell.Utility
ms.date 03/07/2023
online version https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/remove-alias?view=powershell-7.6&WT.mc_id=ps-gethelp
schema 2.0.0
title Remove-Alias

Remove-Alias

SYNOPSIS

Remove an alias from the current session.

SYNTAX

Default (Default)

Remove-Alias [-Name] <String[]> [-Scope <String>] [-Force] [<CommonParameters>]

DESCRIPTION

The Remove-Alias cmdlet removes an alias from the current PowerShell session. To remove an alias with the Option property set to ReadOnly, use the Force parameter.

The Remove-Alias cmdlet was introduced in PowerShell 6.0.

EXAMPLES

Example 1 - Remove an alias

This example removes an alias named del that represents the Remove-Item cmdlet.

Remove-Alias -Name del

Example 2 - Remove all non-Constant aliases

This example removes all aliases from the current PowerShell session, except for aliases with the Options property set to Constant. After the command is run, the aliases are available in other PowerShell sessions or new PowerShell sessions.

Get-Alias | Where-Object { $_.Options -ne "Constant" } | Remove-Alias -Force

Get-Alias gets all the aliases in the PowerShell session and sends the objects down the pipeline. Where-Object uses a script block, and the automatic variable ($_) and Options property represent the current pipeline object. The -ne (not equal) operator selects objects that don't have an Options value set to Constant. Remove-Alias uses the Force parameter to remove aliases, including read-only aliases, from the PowerShell session. The Force parameter can't remove Constant aliases.

PARAMETERS

-Force

Indicates that the cmdlet removes an alias, including aliases with the Option property set to ReadOnly. The Force parameter can't remove an alias with an Option property set to Constant.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Name

Specifies the name of the alias to remove.

Type: System.String[]
Parameter Sets: (All)
Aliases:

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

-Scope

Affects only the aliases in the specified scope. The default scope is Local. For more information, see about_Scopes.

The acceptable values for this parameter are:

  • Global
  • Local
  • Script
  • A number relative to the current scope (0 through the number of scopes, where 0 is the current scope and 1 is its parent)
Type: System.String
Parameter Sets: (All)
Aliases:

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

System.String[]

You can pipe an alias object to this cmdlet.

OUTPUTS

None

This cmdlet returns no output.

NOTES

Changes only affect the current scope. To remove an alias from all sessions, add a Remove-Alias command to your PowerShell profile.

For more information, see about_Aliases.

RELATED LINKS

about_Automatic_Variables

Export-Alias

Get-Alias

Import-Alias

New-Alias

Set-Alias

Where-Object