Export-Alias
Exporta informações sobre aliases atualmente definidos para um arquivo.
Sintaxe
ByPath (Predefinição)
Export-Alias
[-Path] <String>
[[-Name] <String[]>]
[-PassThru]
[-As <ExportAliasFormat>]
[-Append]
[-Force]
[-NoClobber]
[-Description <String>]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByLiteralPath
Export-Alias
[[-Name] <String[]>]
-LiteralPath <String>
[-PassThru]
[-As <ExportAliasFormat>]
[-Append]
[-Force]
[-NoClobber]
[-Description <String>]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Export-Alias exporta os aliases na sessão atual para um arquivo. Se o arquivo de saída não existir, o cmdlet o criará.
Export-Alias pode exportar os aliases em um escopo específico ou todos os escopos, ele 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 PowerShell.
Exemplos
Exemplo 1: Exportar um alias
Export-Alias -Path "alias.csv"
Este comando exporta informações de alias atuais para um arquivo chamado Alias.csv no diretório atual.
Exemplo 2: Exportar um alias, a menos que o arquivo de exportação já exista
Export-Alias -Path "alias.csv" -NoClobber
Este comando exporta os aliases na sessão atual para um arquivo Alias.csv.
Como o parâmetro NoClobber é especificado, o comando falhará se já existir um arquivo Alias.csv no diretório atual.
Exemplo 3: Acrescentar aliases a um ficheiro
Export-Alias -Path "alias.csv" -Append -Description "Appended Aliases" -Force
Este comando acrescenta os aliases na 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 quaisquer ficheiros Alias.csv existentes, mesmo que possuam o atributo somente leitura.
Exemplo 4: Exportar aliases como um script
Export-Alias -Path "alias.ps1" -As Script
Add-Content -Path $PROFILE -Value (Get-Content alias.ps1)
$S = New-PSSession -ComputerName Server01
Invoke-Command -Session $S -FilePath .\alias.ps1
Este exemplo mostra como usar o formato de arquivo de script que Export-Alias gera.
O primeiro comando exporta os aliases na 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 aliases no 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 quarto comandos adicionam os aliases no 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.
Parâmetros
-Append
Indica que este cmdlet acrescenta a saída ao ficheiro especificado, em vez de substituir o conteúdo existente desse ficheiro.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-As
Especifica o formato de saída. CSV é o padrão. Os valores aceitáveis para este parâmetro são:
- CSV. Formato CSV (valores separados por vírgula).
- Roteiro. Cria um comando
Set-Aliaspara 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.
Propriedades dos parâmetros
| Tipo: | ExportAliasFormat |
| Default value: | None |
| Valores aceites: | Csv, Script |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Cf. |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Description
Especifica a descrição do arquivo exportado. A descrição aparece como um comentário na parte superior do arquivo, seguindo as informações do cabeçalho.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Force
Força o comando a ser executado sem pedir a confirmação do usuário.
Substitui o ficheiro de saída, mesmo que o atributo de só leitura esteja definido no ficheiro.
Por padrão, Export-Alias substitui ficheiros sem aviso, a menos que o atributo de somente leitura ou oculto esteja ativado ou que o parâmetro NoClobber seja utilizado no comando. O parâmetro NoClobber tem precedência sobre o parâmetro Force quando ambos são usados em um comando.
O parâmetro Force não pode forçar Export-Alias a sobrescrever ficheiros com o atributo oculto.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-LiteralPath
Especifica o caminho para o arquivo de saída. Ao contrário de Path, o valor do parâmetro LiteralPath é usado exatamente como está digitado. Nenhum caractere é interpretado como carta curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples indicam ao PowerShell para não interpretar quaisquer caracteres como sequências de escape.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | PSPath |
Conjuntos de parâmetros
ByLiteralPath
| Position: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
-Name
Especifica os nomes como uma matriz dos aliases a serem exportados. Curingas são permitidos.
Por padrão, Export-Alias exporta todos os aliases (ou apelidos) na sessão ou escopo.
Propriedades dos parâmetros
| Tipo: | String[] |
| Default value: | None |
| Suporta carateres universais: | True |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | 1 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
-NoClobber
Indica que esse cmdlet impede que Export-Alias substitua quaisquer arquivos, mesmo que o parâmetro Force seja usado no comando.
Se o parâmetro NoClobber for omitido, Export-Alias substituirá um arquivo existente sem aviso, a menos que o atributo somente leitura seja definido no arquivo.
NoClobber tem precedência sobre o parâmetro Force, que permite que Export-Alias substitua um arquivo pelo atributo somente leitura.
NoClobber não impede que o parâmetro Append adicione conteúdo a um arquivo existente.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | NoOverwrite |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Path
Especifica o caminho para o arquivo de saída. Curingas são permitidos, mas o valor do caminho resultante deve ser resolvido para um único nome de arquivo.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | True |
| NãoMostrar: | False |
Conjuntos de parâmetros
ByPath
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Scope
Especifica o escopo do qual os pseudónimos devem ser exportados. Os valores aceitáveis para este parâmetro são:
GlobalLocalScript- Um número relativo ao escopo atual (0 até ao número de escopos onde 0 representa o escopo atual e 1 representa o seu pai)
O valor predefinido é Local. Para obter mais informações, consulte about_Scopes.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Wi |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
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 AliasInfo objeto que representa o alias.
Notas
O Windows PowerShell inclui os seguintes aliases para Export-Alias:
epal
- Você só pode Export-Aliases a um arquivo.
