New-Alias

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

Cria um novo alias.

Syntax

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

Description

O cmdlet New-Alias cria um novo alias na sessão atual do PowerShell. Os aliases criados usando o New-Alias não são salvos após você sair da sessão ou fechar o PowerShell. Você pode usar o cmdlet Export-Alias para salvar as informações de alias em um arquivo. Posteriormente, você pode usar Import-Alias para recuperar as informações de alias salvas.

Exemplos

Exemplo 1: criar um alias para um cmdlet

PS C:\> New-Alias -Name "List" Get-ChildItem

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

Exemplo 2: criar um alias somente leitura para um cmdlet

PS C:\> New-Alias -Name "W" -Value Get-WmiObject -Description "quick wmi alias" -Option ReadOnly
PS C:\> Get-Alias -Name "W" | Format-List *

Esse comando cria um alias chamado W para representar o cmdlet Get-WmiObject. Ele cria uma descrição, alias wmi rápido, para o alias e o torna somente leitura. A última linha do comando usa o Get-Alias para obter o novo alias e o redireciona para Format-List para exibir todas as informações sobre ele.

Parâmetros

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-Force

Indica que o cmdlet atua como Set-Alias se o alias nomeado já existir.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Option

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

  • Nenhum: 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
  • Constante: o alias não pode ser excluído ou alterado
  • Privado: o alias só está disponível no escopo atual
  • AllScope: o alias é copiado para quaisquer novos escopos criados
  • Não especificado: a opção não é especificada

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

Type:ScopedItemOptions
Accepted values:None, ReadOnly, Constant, Private, AllScope, Unspecified
Position:Named
Default value:[System.Management.Automation.ScopedItemOptions]::None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

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

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

-Scope

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

  • Global
  • Local
  • Script
  • Um número relativo ao escopo atual (0 por meio do número de escopos, em que 0 é o escopo atual e 1 é seu pai).

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

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

-Value

Especifica o nome do elemento de comando ou de cmdlet que está recebendo o alias.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

None

Não é possível redirecionar a entrada para este cmdlet.

Saídas

None or System.Management.Automation.AliasInfo

Quando você usa o parâmetro Passthru , New-Alias gera um objeto System.Management.Automation.AliasInfo que representa o novo alias. Caso contrário, este cmdlet não gera nenhuma saída.

Observações

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