Compartilhar via


New-Alias

Cria um novo alias.

Sintaxe

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

Descrição

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

Parâmetros

-Descrição <string>

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

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-Force

Se definido, atua como Set-Alias se o alias nomeado já existir.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-Name <string>

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

Necessário?

true

Posição?

1

Valor padrão

Aceitar entrada do pipeline?

true (ByPropertyName)

Aceitar caracteres curinga?

false

-Option <ScopedItemOptions>

Defina uma ou mais propriedades opcionais do alias. Os valores válidos são:

-- None: não define nenhuma opção. (padrão)

-- ReadOnly: o alias não pode ser alterado, a não ser que você use o parâmetro Force.

-- Constant: o alias não pode ser alterado, nem mesmo usando o parâmetro Force.

-- Private: o alias está disponível apenas no escopo especificado pelo parâmetro Scope. Ele não está visível em todos os outros escopos.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-PassThru

Retorna um objeto que representa o novo alias. Por padrão, este cmdlet não gera nenhuma saída.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-Scope <string>

Especifica o escopo do novo alias. Os valores válidos são "Global", "Local" ou "Script" ou um número relativo ao atual escopo (0 ao número de escopos, onde 0 é o escopo atual e 1 é seu pai). "Local" é o padrão. Para obter mais informações, consulte about_Scopes.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-Value <string>

Especifica o nome do cmdlet ou elemento do comando que está passando por alias.

Necessário?

true

Posição?

2

Valor padrão

Aceitar entrada do pipeline?

true (ByPropertyName)

Aceitar caracteres curinga?

false

-Confirm

Solicita confirmação antes da execução do comando.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-WhatIf

Descreve o que aconteceria se você executasse o comando, sem executá-lo de fato.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

<CommonParameters>

Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.

Entradas e saídas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.

Entradas

Nenhum

Você não pode canalizar a entrada para este cmdlet.

Saídas

Nenhum ou 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, esse 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.

Exemplo 1

C:\PS>new-alias list get-childitem

Descrição
-----------
Esse comando cria um alias denominado "list" para representar o cmdlet Get-ChildItem.





Exemplo 2

C:\PS>new-alias -name w -value get-wmiobject -description "quick wmi alias" -option ReadOnly

C:\PS> get-alias -name w | format-list *

Descrição
-----------
Esse comando cria um alias denominado "w" para representar o cmdlet Get-WMIObject. Ele cria uma descrição, "quick wmi alias", para o alias e o torna somente leitura. A última linha do comando usa Get-Alias para obter o novo alias e o canaliza para Format-List a fim de exibir todas as informações sobre ele.





Consulte também

Conceitos

Set-Alias
Get-Alias
Export-Alias
Import-Alias