New-Alias
Cria um novo alias.
Syntax
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. Posteriormente, você pode usar Import-Alias
para recuperar as informações de alias salvas.
Exemplos
Exemplo 1: Create um alias para um cmdlet
New-Alias -Name "List" Get-ChildItem
Esse comando cria um alias chamado List para representar o cmdlet Get-ChildItem.
Exemplo 2: Create um alias somente leitura para um cmdlet
New-Alias -Name "C" -Value Get-ChildItem -Description "quick gci alias" -Option ReadOnly
Get-Alias -Name "C" | Format-List *
Esse comando cria um alias chamado C
para representar o Get-ChildItem
cmdlet . Ele cria uma descrição, alias wmi rápido, para o alias e o torna somente leitura. A última linha do comando usa Get-Alias
para obter o novo alias e redirecioná-lo 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 age 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:
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 ForceConstant
: o alias não pode ser excluído ou alteradoPrivate
: o alias está disponível apenas no escopo atualAllScope
: o alias é copiado para quaisquer novos escopos criadosUnspecified
: a opção não está especificada
Esses valores são definidos como uma enumeração baseada em sinalizador. Você pode combinar vários valores 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 a conclusão 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
.
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 pelo número de escopos, em
0
que é o escopo atual e1
é 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
ouNew-Alias
. Para alterar um alias, useSet-Alias
. Para excluir um alias, useRemove-Item
.