Compartilhar via


Export-Alias

Exporta informações sobre os aliases atualmente definidos para um arquivo.

Sintaxe

Export-Alias [-Path] <string> [[-Name] <string[]>] [-Append] [-As {<Csv> | <Script>}] [-Descrição <string>] [-Force] [-NoClobber] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]

Descrição

O cmdlet Export-Alias exporta os alias da sessão atual para um arquivo. Se o arquivo de saída não existir, o cmdlet irá criá-lo.

Export-Alias pode exportar os aliases em um escopo específico ou em todos os escopos, pode gerar os dados em formato CSV ou como uma série de comandos Set-Alias que você pode adicionar a uma sessão ou a um perfil do Windows PowerShell.

Parâmetros

-Append

Acrescenta a saída ao arquivo especificado, em vez de substituir o conteúdo existente do arquivo.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-As <ExportAliasFormat>

Determina o formato de saída. CSV é o padrão.

Os valores válidos são:

-- CSV: formato CSV (valores separados por vírgula).

-- Script: cria um comando Set-Alias para cada alias exportado. Se você nomear o arquivo de saída com uma extensão de nome de arquivo .ps1, poderá executá-lo como um script para adicionar os aliases a qualquer sessão.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-Descrição <string>

Adiciona uma descrição ao arquivo exportado. A descrição aparece como um comentário na parte superior do arquivo, após as informações do cabeçalho.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-Force

Substitui o arquivo de saída, mesmo que o atributo somente leitura esteja definido no arquivo.

Por padrão, Export-Alias substitui arquivos sem aviso prévio, a menos que o atributo somente leitura ou oculto esteja definido ou que o parâmetro NoClobber seja usado no comando. O parâmetro NoClobber tem precedência sobre o parâmetro Force quando os dois são usados em um comando.

O parâmetro Force não pode forçar o Export-Alias a substituir arquivos com o atributo oculto.

Necessário?

false

Posição?

named

Valor padrão

Não substitui arquivos somente leitura.

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-Name <string[]>

Especifica os nomes dos aliases a serem exportados. Os caracteres curinga são permitidos.

Por padrão, o Export-Alias exporta todos os alias da sessão ou escopo.

Necessário?

false

Posição?

2

Valor padrão

Exporta todos os aliases

Aceitar entrada do pipeline?

true (ByPropertyName)

Aceitar caracteres curinga?

false

-NoClobber

Impede que Export-Alias substitua qualquer arquivo, mesmo que o parâmetro Force seja usado no comando.

Se o parâmetro NoClobber for omitido, o Export-Alias substituirá um arquivo existente sem aviso prévio, a menos que o atributo somente leitura esteja definido no arquivo. NoClobber tem precedência sobre o parâmetro Force, o que permite que o Export-Alias substitua um arquivo com o atributo somente leitura.

NoClobber não impede que o parâmetro Append acrescente conteúdo a um arquivo existente.

Necessário?

false

Posição?

named

Valor padrão

Substitui arquivos de leitura-gravação.

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-PassThru

Retorna objetos que representam os aliases exportados. Por padrão, este cmdlet não gera nenhuma saída.

Necessário?

false

Posição?

named

Valor padrão

Nenhuma saída

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-Path <string>

Especifica o caminho para o arquivo de saída. Caracteres curinga são permitidos, mas o valor do caminho resultante deve ser um único nome de arquivo. Esse parâmetro é obrigatório.

Necessário?

true

Posição?

1

Valor padrão

Nenhum

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-Scope <string>

Especifica o escopo a partir do qual os aliases devem ser exportados.

Os valores válidos são "Global", "Local" ou "Script" ou um número relativo ao escopo atual (de 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

Local

Aceitar entrada do pipeline?

false

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 objetos para este cmdlet.

Saídas

Nenhum ou System.Management.Automation.AliasInfo

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

Observações

O Export-Alias só pode ser usado para um arquivo.

Exemplo 1

C:\PS>export-alias -path alias.csv

Descrição
-----------
Esse comando exporta as informações do alias atual para um arquivo denominado Alias.txt no diretório atual.





Exemplo 2

C:\PS>export-alias -path alias.csv -noclobber

Descrição
-----------
Esse comando exporta os aliases da sessão atual para um arquivo Alias.csv. 

Como o parâmetro NoClobber está especificado, o comando falhará se um arquivo Alias.csv já existir no diretório atual.





Exemplo 3

C:\PS>export-alias -path alias.csv -append -description "Appended Aliases" -force

Descrição
-----------
Esse comando acrescenta os alias da sessão atual ao arquivo Alias.csv. 

O comando usa o parâmetro Description para adicionar uma descrição aos comentários na parte superior do arquivo. 

O comando também usa o parâmetro Force para substituir todos os arquivos Alias.csv existentes, mesmos que eles tenham o atributo somente leitura.





Exemplo 4

C:\PS>export-alias -path alias.ps1 -as script

C:\PS> add-content -path $profile -value (get-content alias.ps1)

C:\PS> $s = new-pssession -computername Server01
C:\PS> invoke-command -session $s -filepath .\alias.ps1

Descrição
-----------
Esse exemplo mostra como usar o formato de arquivo de script gerado pelo Export-Alias.

O primeiro comando exporta os alias da sessão para o arquivo Alias.ps1. Ele usa o parâmetro As com um valor de Script para gerar um arquivo que contém um comando Set-Alias para cada alias.

O segundo comando adiciona os alias do arquivo Alias.ps1 ao perfil CurrentUser-CurrentHost. (O caminho para o perfil é salvo na variável $profile.) O comando usa o cmdlet Get-Content para obter os aliases do arquivo Alias.ps1 e o cmdlet Add-Content para adicioná-los ao perfil. Para obter mais informações, consulte about_Profiles.

O terceiro e o quarto comandos adicionam os alias do arquivo Alias.ps1 a uma sessão remota no computador Server01. O terceiro comando usa o cmdlet New-PSSession para criar a sessão. O quarto comando usa o parâmetro FilePath do cmdlet Invoke-Command para executar o arquivo Alias.ps1 na nova sessão.





Consulte também

Conceitos

Import-Alias
Get-Alias
New-Alias
Set-Alias