New-Alias

Referencia

Módulo:: Microsoft.PowerShell.Utility

Crea un nuevo alias.

Sintaxis

New-Alias
   [-Name] <String>
   [-Value] <String>
   [-Description <String>]
   [-Option <ScopedItemOptions>]
   [-PassThru]
   [-Scope <String>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

El cmdlet New-Alias crea un nuevo alias en la sesión actual de PowerShell. Los alias creados mediante New-Alias no se guardan después de salir de la sesión o cerrar PowerShell. Puede usar el cmdlet Export-Alias para guardar la información de alias en un archivo. Más adelante puede usar Import-Alias para recuperar esa información de alias guardada.

Ejemplos

Ejemplo 1: Creación de un alias para un cmdlet

New-Alias -Name "List" Get-ChildItem

Este comando crea un alias denominado List para representar el cmdlet Get-ChildItem.

Ejemplo 2: Creación de un alias de solo lectura para un cmdlet

Este comando crea un alias denominado C para representar el cmdlet Get-ChildItem. Crea una descripción de "Alias de gci rápido" para el alias y lo convierte en de solo lectura.

New-Alias -Name "C" -Value Get-ChildItem -Description "Quick gci alias" -Option ReadOnly
Get-Alias -Name "C" | Format-List *

HelpUri             : https://go.microsoft.com/fwlink/?LinkID=2096492
ResolvedCommandName : Get-ChildItem
DisplayName         : C -> Get-ChildItem
ReferencedCommand   : Get-ChildItem
ResolvedCommand     : Get-ChildItem
Definition          : Get-ChildItem
Options             : ReadOnly
Description         : Quick gci alias
OutputType          : {System.IO.FileInfo, System.IO.DirectoryInfo}
Name                : C
CommandType         : Alias
Source              :
Version             :
Visibility          : Public
ModuleName          :
Module              :
RemotingCapability  : PowerShell
Parameters          : {[Path, System.Management.Automation.ParameterMetadata], [LiteralPath,
                      System.Management.Automation.ParameterMetadata], [Filter,
                      System.Management.Automation.ParameterMetadata], [Include,
                      System.Management.Automation.ParameterMetadata]…}

El comando Get-Alias canaliza para Format-List muestra toda la información sobre el nuevo alias.

Ejemplo 3: Creación de un alias para un comando con parámetros

function Set-ParentDirectory {Set-Location -Path ..}
New-Alias -Name .. -Value Set-ParentDirectory

El primer comando crea la función Set-ParentDirectory, que usa Set-Location para establecer la ubicación de trabajo en el directorio primario. El segundo comando usa New-Alias para crear un alias de .. para llamar a la función Set-ParentDirectory. Dado que el parámetro Value requiere un cmdlet, una función o un valor ejecutable, debe crear una función personalizada para crear un alias que use parámetros. Al ejecutar el alias .. cambia la ubicación actual al directorio primario.

Parámetros

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Tipo:	SwitchParameter
Alias:	cf
Posición:	Named
Valor predeterminado:	False
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Description

Especifica una descripción del alias. Puede escribir cualquier cadena. Si la descripción incluye espacios, escríbalo entre comillas.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Force

Indica que el cmdlet actúa como Set-Alias si el alias denominado ya existe.

Tipo:	SwitchParameter
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Name

Especifica el nuevo alias. Puede usar cualquier carácter alfanumérico en un alias, pero el primer carácter no puede ser un número.

Tipo:	String
Posición:	0
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-Option

Especifica el valor de Options propiedad del alias. Los valores válidos son:

None: el alias no tiene restricciones (valor predeterminado)
ReadOnly: el alias se puede eliminar, pero no se puede cambiar, excepto mediante el uso del parámetro Force
Constant: no se puede eliminar ni cambiar el alias
Private: el alias solo está disponible en el ámbito actual.
AllScope: el alias se copia en cualquier ámbito nuevo que se cree.
Unspecified: no se especifica la opción

Estos valores se definen como una enumeración basada en marcas. Puede combinar varios valores para establecer varias marcas mediante este parámetro. Los valores se pueden pasar al parámetro Option como una matriz de valores o como una cadena separada por comas de esos valores. El cmdlet combinará los valores mediante una operación binary-OR. Pasar valores como una matriz es la opción más sencilla y también permite usar la finalización de tabulación en los valores.

Para ver la propiedad Opciones de de todos los alias de la sesión, escriba Get-Alias | Format-Table -Property Name, Options -AutoSize.

Tipo:	ScopedItemOptions
Valores aceptados:	None, ReadOnly, Constant, Private, AllScope, Unspecified
Posición:	Named
Valor predeterminado:	[System.Management.Automation.ScopedItemOptions]::None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ninguna salida.

Tipo:	SwitchParameter
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Scope

Especifica el ámbito del nuevo alias. Los valores aceptables para este parámetro son:

Global
Local
Script
Número relativo al ámbito actual (de 0 al número de ámbitos, donde 0 es el ámbito actual y 1 es su elemento primario).

Local es el valor predeterminado. Para obtener más información, vea about_Scopes.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Value

Especifica el nombre del cmdlet o elemento de comando que se está aliasando.

Tipo:	String
Posición:	1
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-WhatIf

Muestra lo que sucedería si el cmdlet se ejecuta. El cmdlet no se ejecuta.

Tipo:	SwitchParameter
Alias:	wi
Posición:	Named
Valor predeterminado:	False
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

Entradas

None

No se pueden canalizar objetos a este cmdlet.

Salidas