Partilhar via

New-Alias

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Cria um novo alias.

Sintaxe

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

Description

O New-Alias cmdlet cria um novo alias na sessão atual do PowerShell. Os aliases criados usando New-Alias não são salvos depois que você sai da sessão ou fecha o PowerShell. Você pode usar o Export-Alias cmdlet para salvar suas informações de alias em um arquivo. Mais tarde, você pode usar Import-Alias para recuperar essas informações de alias salvas.

Exemplos

Exemplo 1: Criar um alias para um cmdlet

New-Alias -Name "List" Get-ChildItem

Este comando cria um alias chamado List para representar o cmdlet Get-ChildItem.

Exemplo 2: Criar um alias somente leitura para um cmdlet

Este comando cria um alias nomeado C para representar o Get-ChildItem cmdlet. Ele cria uma descrição de "alias gci rápido" para o alias e o torna somente leitura.

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]…}

O Get-Alias comando canalizado para Format-List mostra todas as informações sobre o novo alias.

Exemplo 3: Criar um alias para um comando com parâmetros

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

O primeiro comando cria a função Set-ParentDirectory, que usa Set-Location para definir o local de trabalho para o diretório pai. O segundo comando usa New-Alias para criar um alias de .. para chamar a Set-ParentDirectory função. Como o parâmetro Value requer um cmdlet, função ou valor executável, você deve criar uma função personalizada para criar um alias que use parâmetros. A execução do alias .. altera o local atual para o diretório pai.

Parâmetros

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Description

Especifica uma descrição do alias. Você pode digitar qualquer cadeia de caracteres. Se a descrição incluir espaços, coloque-a entre aspas.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Force

Indica que o cmdlet age como Set-Alias se o alias nomeado já existisse.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Name

Especifica o novo alias. Você pode usar qualquer caractere alfanumérico em um alias, mas o primeiro caractere não pode ser um número.

Tipo:String
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Option

Especifica o valor da propriedade Options do alias. Os valores válidos são:

  • None: O alias não tem restrições (valor padrão)
  • ReadOnly: O alias pode ser excluído, mas não pode ser alterado, exceto usando o parâmetro Force
  • Constant: O alias não pode ser excluído ou alterado
  • Private: O alias está disponível apenas no escopo atual
  • AllScope: O alias é copiado para todos os novos escopos criados
  • Unspecified: A opção não é especificada

Esses valores são definidos como uma enumeração baseada em sinalizador. Você pode combinar vários valores juntos para definir vários sinalizadores usando esse parâmetro. Os valores podem ser passados para o parâmetro Option como uma matriz de valores ou como uma cadeia de caracteres separada por vírgulas desses valores. O cmdlet combinará os valores usando uma operação binary-OR. Passar valores como uma matriz é a opção mais simples e também permite que você use o preenchimento de tabulação nos valores.

Para ver a propriedade Options de todos os aliases na sessão, digite Get-Alias | Format-Table -Property Name, Options -AutoSize.

Tipo:ScopedItemOptions
Valores aceites:None, ReadOnly, Constant, Private, AllScope, Unspecified
Position:Named
Default value:[System.Management.Automation.ScopedItemOptions]::None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-PassThru

Retorna um objeto que representa o item com o qual você está trabalhando. Por padrão, esse cmdlet não gera nenhuma saída.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Scope

Especifica o escopo do novo alias. Os valores aceitáveis para este parâmetro são:

  • Global
  • Local
  • Script
  • Um número relativo ao escopo atual (0 através do número de escopos, onde 0 é o escopo atual e 1 é seu pai).

Local é a predefinição. Para obter mais informações, consulte about_Scopes.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Value

Especifica o nome do cmdlet ou elemento de comando que está sendo aliased.

Tipo:String
Position:1
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

None

Não é possível canalizar objetos para este cmdlet.

Saídas

None

Por padrão, esse cmdlet não retorna nenhuma saída.

AliasInfo

Quando você usa o parâmetro PassThru , esse cmdlet retorna um objeto AliasInfo que representa o novo alias.

Notas

O PowerShell inclui os seguintes aliases para New-Alias:

  • Todas as plataformas:

    • nal

  • Para criar um novo alias, use Set-Alias ou New-Alias. Para alterar um alias, use Set-Alias. Para excluir um alias, use Remove-Alias.