Set-Alias

Crea o cambia un alias (nombre alternativo) de un cmdlet o cualquier otro elemento de comando de la sesión actual de Windows PowerShell.

Sintaxis

Set-Alias [-Name] <string> [-Value] <string> [-Description <string>] [-Force] [-Option {<None> | <ReadOnly> | <Constant> | <Private> | <AllScope>}] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]

Descripción

El cmdlet Set-Alias crea o cambia un alias (nombre alternativo) de un cmdlet u otro elemento de comando, como una función, un script, un archivo u otro ejecutable. También puede usar Set-Alias para reasignar el alias actual a un nuevo comando o cambiar cualquiera de las propiedades de un alias, como su descripción. A menos que agregue el alias al perfil de Windows PowerShell, los cambios que realice en el alias se perderán al terminar la sesión o cerrar Windows PowerShell.

Parámetros

-Description <string>

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

-Force

Permite al cmdlet establecer un alias de solo lectura. Utilice el parámetro Option para crear un alias de solo lectura. El parámetro Force no puede establecer un alias constante.

-Name <string>

Especifica el nuevo alias. Pueden usarse caracteres alfanuméricos en los alias, pero el primer carácter no puede ser un número.

-Option <ScopedItemOptions>

Establece el valor de la propiedad Options de un alias.

Los valores válidos son:

-- None: no establece opciones. (Valor predeterminado.)

-- ReadOnly: no se pueden cambiar las propiedades del alias, excepto con el parámetro Force. Se puede usar Remove-Item para eliminar el alias.

-- Constant: no se puede eliminar el alias ni se pueden cambiar sus propiedades. El valor Constant está disponible únicamente cuando se crea un alias. No se puede cambiar la opción de un alias existente a Constant.

-- Private: el alias solo está disponible en el ámbito especificado por el parámetro Scope. En los demás ámbitos, el alias no está visible.

-- AllScope: el alias se copia en los nuevos ámbitos que se creen.

Para ver la propiedad Options de los alias, escriba "Get-Alias | Format-Table -property Name, Definition, Options -autosize".

-PassThru

Devuelve un objeto que representa el alias. De forma predeterminada, este cmdlet no genera resultados.

-Scope <string>

Especifica el ámbito en el que es válido este alias. Los valores válidos son "Global", "Local", "Script" o el número correspondiente al ámbito actual (entre 0 y el número de ámbitos, donde 0 es el ámbito actual y 1 su ámbito principal). "Local" es el valor predeterminado. Para obtener más información, vea about_Scopes.

-Value <string>

Especifica el nombre del elemento de cmdlet o comando al que se asigna un alias.

-Confirm

Solicita confirmación antes de ejecutar el comando.

-WhatIf

Describe lo que ocurriría si ejecutara el comando sin ejecutarlo realmente.

<CommonParameters>

Este cmdlet admite los parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, vea about_Commonparameters.

Entradas y salidas

El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet. El tipo devuelto es el tipo de los objetos que el cmdlet devuelve.

Notas

Un alias es un nombre alternativo o sobrenombre de un cmdlet o un elemento de comando. Para ejecutar el cmdlet, puede usarse su nombre completo o su alias correspondiente. Para obtener más información, vea about_Aliases.

Para crear un nuevo alias, use Set-Alias o New-Alias. Para eliminar un alias, use Remove-Item.

Un cmdlet puede tener varios alias, pero un alias sólo puede estar asociado a un único cmdlet. Si usa set-alias para asociar al alias con un cmdlet diferente, dicho alias dejará de estar vinculado con el cmdlet original.

Se puede crear un alias para un cmdlet, pero no se puede crear un alias para un comando con parámetros y valores. Por ejemplo, puede crear un alias para Set-Location, pero no para "Set-Location C:\Windows\System32". Para crear un alias de un comando, cree una función que contenga el comando y, a continuación, cree un alias para la función.

Para guardar los alias de una sesión y usarlos en una sesión diferente, agregue el comando set-alias a su perfil de Windows PowerShell. Los perfiles no existen de manera predeterminada. Para crear un perfil en la ruta de acceso almacenada en la variable $profile, escriba "New-Item -type file -force $profile". Para ver el valor de la variable $profile, escriba "$profile".

También puede guardar los alias mediante Export-Alias para copiar los alias de la sesión en un archivo; a continuación, puede usar Import-Alias para agregarlos a la lista de alias de una nueva sesión.

También puede hacer referencia a Set-Alias mediante su alias integrado, "sal". Para obtener más información, vea about_Aliases.

Ejemplo 1

C:\PS>set-alias -name list -value get-childitem

Descripción
-----------
Este comando crea el alias "list" para el cmdlet Get-ChildItem. Después de crear el alias, podrá usar "list" en lugar de "Get-ChildItem" en la línea de comandos y en los scripts.

Ejemplo 2

C:\PS>set-alias list get-location

Descripción
-----------
Este comando asocia el alias "list" con el cmdlet Get-Location. Si "list" es el alias de otro cmdlet, este comando modificará su asociación de modo que pase a ser únicamente el alias de Get-Location.

Este comando usa el mismo formato que el comando del ejemplo anterior, pero omite los nombres de parámetros opcionales, -Name y -Value. Cuando se omiten los nombres de parámetros, los valores de esos parámetros deben aparecer en el comando en el orden especificado. En este caso, el valor de -Name ("list") debe ser el primer parámetro y el valor de -Value ("get-location") debe ser el segundo parámetro.

Ejemplo 3

C:\PS>set-alias scrub remove-item -option readonly -passthru | format-list

Descripción
-----------
Este comando asocia el alias "scrub" con el cmdlet Remove-Item. Usa la opción "ReadOnly" para evitar que se borre el alias o que se asigne a otro cmdlet.

El parámetro PassThru indica a Windows PowerShell que pase un objeto que represente el nuevo alias a través de la canalización al cmdlet Format-List. Si se omite el parámetro PassThru, no se generará ningún resultado en este cmdlet que pudiera mostrarse (en una lista u otro soporte).

Ejemplo 4

C:\PS>Set-Alias np c:\windows\notepad.exe

Descripción
-----------
Este comando asocia el alias "np" con el archivo ejecutable de Bloc de notas. Una vez que el comando finaliza su ejecución, basta con escribir "np". para abrir Bloc de notas desde la línea de comandos de Windows PowerShell.

En este ejemplo se muestra cómo se crean alias para archivos ejecutables y otros elementos que no son cmdlets.

Para que el comando resulte más general, puede usarse la variable de entorno "Windir" (${env:windir}) para representar el directorio C\Windows. La versión genérica del comando es "set-alias np ${env:windir}\notepad.exe".

Ejemplo 5

C:\PS>function CD32 {set-location c:\windows\system32}

C:\PS>set-alias go cd32

Descripción
-----------
Estos comandos muestra cómo se asigna una alias a un comando con parámetros o incluso a una canalización de muchos comandos.

Se puede crear un alias para un cmdlet, pero no se puede crear un alias para un comando compuesto por un cmdlet y sus parámetros. Sin embargo, si sitúa el comando en una función o un script, puede crear a continuación un nombre útil para a la función o el script, además de uno o varios alias para la función o el script.

En este ejemplo, el usuario desea crear un alias para el comando "set-location c:\windows\system32", donde "set-location" es un cmdlet y "C:\Windows\System32" es el valor del parámetro Path. 

Para ello, el primer comando crea una función denominada "CD32" que contiene el comando Set-Location.

El segundo comando crea el alias "go" para la función CD32. A continuación, para ejecutar el comando Set-Location, el usuario puede escribir "CD32" o "go".

Vea también

Conceptos

Get-Alias
New-Alias
Export-Alias
Import-Alias