Import-Alias

Imports an alias list from a file.
Import-Alias [-Path*] <String> [-Force] [-PassThru] [-Scope [<String>]] [-Confirm] [-WhatIf] [<CommonParameters>]
Import-Alias [-Force] [-PassThru] [-Scope [<String>]] -LiteralPath* <String> [-Confirm] [-WhatIf][<CommonParameters>]

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.

Parameters
-Force [<SwitchParameter>]

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.

-PassThru [<SwitchParameter>]

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

-Path <String>

  • This value is required
  • Accepts pipeline input ByValue

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

-Scope [<String>]

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.

-LiteralPath <String>

  • This value is required
  • Accepts pipeline input ByValue

Specifies the path to a file that includes exported alias information. Unlike Path, 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 Windows PowerShell not to interpret any characters as escape sequences.

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

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

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

System.String

You can pipe a string that contains a path to Import-Alias.

Outputs

None or System.Management.Automation.AliasInfo

When you use the Passthru parameter, Import-Alias returns a System.Management.Automation.AliasInfo object that represents the alias. Otherwise, this cmdlet does not generate any output.

Examples
  1. Import aliases from a file:
    PS C:> Import-Alias test.txt
    

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

Related Links

Export-Alias
Get-Alias
New-Alias
Set-Alias