Skip to content

Import-Alias.md

Latest commit

 

History

History
221 lines (156 loc) · 5 KB

Import-Alias.md

File metadata and controls

221 lines (156 loc) · 5 KB
external help file Microsoft.PowerShell.Commands.Utility.dll-Help.xml
Locale en-US
Module Name Microsoft.PowerShell.Utility
ms.date 12/12/2022
online version https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/import-alias?view=powershell-7.6&WT.mc_id=ps-gethelp
schema 2.0.0
aliases
ipal
title Import-Alias

Import-Alias

SYNOPSIS

Imports an alias list from a file.

SYNTAX

ByPath (Default)

Import-Alias [-Path] <String> [-Scope <String>] [-PassThru] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

ByLiteralPath

Import-Alias -LiteralPath <String> [-Scope <String>] [-PassThru] [-Force] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

The Import-Alias cmdlet imports an alias list from a file.

Beginning in Windows PowerShell 3.0, as a security feature, Import-Alias does not overwrite existing aliases by default. To overwrite an existing alias, after assuring that the contents of the alias file is safe, use the Force parameter.

EXAMPLES

Example 1: Import aliases from a file

Import-Alias test.txt

This command imports alias information from a file named test.txt.

PARAMETERS

-Force

Allows the cmdlet to import an alias that is already defined or is read only. You can use the following command to display information about the currently-defined aliases:

Get-Alias | Select-Object Name, Options

If the corresponding alias is read-only, it will be displayed in the value of the Options property.

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

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

-LiteralPath

Specifies the path to a file that includes exported alias information. Unlike the Path parameter, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.

Type: System.String
Parameter Sets: ByLiteralPath
Aliases: PSPath, LP

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

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

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

-Path

Specifies the path to a file that includes exported alias information. Wildcards are allowed but they must resolve to a single name.

Type: System.String
Parameter Sets: ByPath
Aliases:

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

-Scope

Specifies the scope into which the aliases are imported. 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)

The default is Local. For more information, see about_Scopes.

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

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: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

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

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

Required: False
Position: Named
Default value: False
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 a string that contains a path to this cmdlet.

OUTPUTS

None

By default, this cmdlet returns no output.

System.Management.Automation.AliasInfo

When you use the PassThru parameter, this cmdlet returns an AliasInfo object representing the alias.

NOTES

PowerShell includes the following aliases for Import-Alias:

  • All platforms:
    • ipal

RELATED LINKS

Export-Alias

Get-Alias

New-Alias

Set-Alias