Share via

Export-Alias

  • Odwołanie
Moduł:
Microsoft.PowerShell.Utility

Eksportuje informacje o aktualnie zdefiniowanych aliasach do pliku.

Składnia

Export-Alias
      [-Path] <String>
      [[-Name] <String[]>]
      [-PassThru]
      [-As <ExportAliasFormat>]
      [-Append]
      [-Force]
      [-NoClobber]
      [-Description <String>]
      [-Scope <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Export-Alias
      -LiteralPath <String>
      [[-Name] <String[]>]
      [-PassThru]
      [-As <ExportAliasFormat>]
      [-Append]
      [-Force]
      [-NoClobber]
      [-Description <String>]
      [-Scope <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Opis

Polecenie Export-Alias cmdlet eksportuje aliasy w bieżącej sesji do pliku. Jeśli plik wyjściowy nie istnieje, polecenie cmdlet go utworzy.

Export-Alias Może wyeksportować aliasy w określonym zakresie lub we wszystkich zakresach, może wygenerować dane w formacie CSV lub jako serię Set-Alias poleceń, które można dodać do sesji lub do profilu programu PowerShell.

Przykłady

Przykład 1. Eksportowanie aliasu

Export-Alias -Path "alias.csv"

To polecenie eksportuje bieżące informacje aliasu do pliku o nazwie Alias.csv w bieżącym katalogu.

Przykład 2: Eksportowanie aliasu, chyba że plik eksportu już istnieje

Export-Alias -Path "alias.csv" -NoClobber

To polecenie eksportuje aliasy w bieżącej sesji do pliku Alias.csv.

Ponieważ określono parametr NoClobber , polecenie zakończy się niepowodzeniem, jeśli plik Alias.csv już istnieje w bieżącym katalogu.

Przykład 3. Dołączanie aliasów do pliku

Export-Alias -Path "alias.csv" -Append -Description "Appended Aliases" -Force

To polecenie dołącza aliasy w bieżącej sesji do pliku Alias.csv.

Polecenie używa parametru Description , aby dodać opis do komentarzy w górnej części pliku.

Polecenie używa również parametru Force , aby zastąpić wszystkie istniejące pliki Alias.csv, nawet jeśli mają atrybut tylko do odczytu.

Przykład 4. Eksportowanie aliasów jako skryptu

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

W tym przykładzie pokazano, jak używać formatu pliku skryptu, który Export-Alias generuje.

Pierwsze polecenie eksportuje aliasy w sesji do pliku Alias.ps1. Używa parametru As z wartością Script do wygenerowania pliku zawierającego Set-Alias polecenia dla każdego aliasu.

Drugie polecenie dodaje aliasy w pliku Alias.ps1 do profilu CurrentUser-CurrentHost. Ścieżka do profilu jest zapisywana w zmiennej $Profile . Polecenie używa Get-Content polecenia cmdlet do pobrania aliasów z pliku Alias.ps1 i Add-Content polecenia cmdlet w celu dodania ich do profilu. Aby uzyskać więcej informacji, zobacz about_Profiles.

Trzecie i czwarte polecenia dodają aliasy w pliku Alias.ps1 do sesji zdalnej na komputerze Server01. Trzecie polecenie używa New-PSSession polecenia cmdlet do utworzenia sesji. Czwarte polecenie używa parametru Invoke-CommandFilePath polecenia cmdlet do uruchomienia pliku Alias.ps1 w nowej sesji.

Parametry

-Append

Wskazuje, że to polecenie cmdlet dołącza dane wyjściowe do określonego pliku, zamiast zastępować istniejącą zawartość tego pliku.

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

-As

Określa format danych wyjściowych. Plik CSV jest wartością domyślną. Dopuszczalne wartości dla tego parametru to:

  • CSV. Format wartości rozdzielanych przecinkami (CSV).
  • Skrypt. Set-Alias Tworzy polecenie dla każdego wyeksportowanego aliasu. Jeśli nazwa pliku wyjściowego ma rozszerzenie nazwy pliku .ps1, możesz uruchomić go jako skrypt, aby dodać aliasy do dowolnej sesji.
Type:ExportAliasFormat
Accepted values:Csv, Script
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

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

-Description

Określa opis wyeksportowanego pliku. Opis jest wyświetlany jako komentarz w górnej części pliku, zgodnie z informacjami nagłówka.

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

-Force

Wymusza uruchomienie polecenia bez monitowania o potwierdzenie użytkownika.

Zastępuje plik wyjściowy, nawet jeśli atrybut tylko do odczytu jest ustawiony w pliku.

Domyślnie Export-Alias zastępuje pliki bez ostrzeżenia, chyba że atrybut tylko do odczytu lub ukryty jest ustawiony lub parametr NoClobber jest używany w poleceniu . Parametr NoClobber ma pierwszeństwo przed parametrem Force , gdy oba są używane w poleceniu.

Parametr Force nie może wymusić Export-Alias zastąpienia plików atrybutem ukrytym.

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

-LiteralPath

Określa ścieżkę do pliku wyjściowego. W przeciwieństwie do ścieżki wartość parametru LiteralPath jest używana dokładnie tak, jak jest typowana. Znaki nie są interpretowane jako symbole wieloznaczne. Jeśli ścieżka zawiera znaki ucieczki, należy ująć ją w znaki pojedynczego cudzysłowu. Znaki pojedynczego cudzysłowu informują program PowerShell, aby nie interpretował żadnych znaków jako sekwencji ucieczki.

Type:String
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Określa nazwy jako tablicę aliasów do wyeksportowania. Dozwolone są symbole wieloznaczne.

Domyślnie Export-Alias eksportuje wszystkie aliasy w sesji lub zakresie.

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

-NoClobber

Wskazuje, że to polecenie cmdlet uniemożliwia Export-Alias zastępowanie plików, nawet jeśli parametr Force jest używany w poleceniu .

Jeśli parametr NoClobber zostanie pominięty, Export-Alias zastąpi istniejący plik bez ostrzeżenia, chyba że atrybut tylko do odczytu jest ustawiony w pliku. Parametr NoClobber ma pierwszeństwo przed parametrem Force , który pozwala Export-Alias zastąpić plik atrybutem tylko do odczytu.

Parametr NoClobber nie uniemożliwia dodawania zawartości do istniejącego pliku przez parametr Append.

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

-PassThru

Zwraca obiekt reprezentujący element, z którym pracujesz. Domyślnie to polecenie cmdlet nie generuje żadnego wyniku.

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

-Path

Określa ścieżkę do pliku wyjściowego. Dozwolone są symbole wieloznaczne, ale wynikowa wartość ścieżki musi być rozpoznawana jako pojedyncza nazwa pliku.

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

-Scope

Określa zakres, z którego mają być eksportowane aliasy. Dopuszczalne wartości dla tego parametru to:

  • Globalnie
  • Lokalne
  • Skrypt
  • Liczba względem bieżącego zakresu (od 0 do liczby zakresów, w których 0 jest bieżącym zakresem, a 1 jest jego elementem nadrzędnym)

Wartość domyślna to Local (Lokalny). Aby uzyskać więcej informacji, zobacz about_Scopes.

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

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

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

Dane wejściowe

None.

Nie można potokować obiektów do tego polecenia cmdlet.

Dane wyjściowe

None or System.Management.Automation.AliasInfo

W przypadku użycia parametru Export-AliasPassthru zwraca obiekt System.Management.Automation.AliasInfo reprezentujący alias. W przeciwnym razie to polecenie cmdlet nie generuje żadnych danych wyjściowych.

Uwagi

  • Można Export-Aliases tylko do pliku.