Export-Alias

  • Reference
Modul:
Microsoft.PowerShell.Utility

Exportuje informace o aktuálně definovaných aliasech do souboru.

Syntax

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>]

Description

Rutina Export-Alias exportuje aliasy v aktuální relaci do souboru. Pokud výstupní soubor neexistuje, rutina ho vytvoří.

Export-Alias může exportovat aliasy v určitém oboru nebo všech oborech, může generovat data ve formátu CSV nebo jako řadu příkazů Set-Alias, které můžete přidat do relace nebo do profilu PowerShellu.

Příklady

Příklad 1: Export aliasu

Export-Alias -Path "alias.csv"

Tento příkaz exportuje informace o aktuálním aliasu do souboru s názvem Alias.csv v aktuálním adresáři.

Příklad 2: Export aliasu, pokud soubor exportu již neexistuje

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

Tento příkaz exportuje aliasy v aktuální relaci do souboru Alias.csv.

Vzhledem k tomu, že je zadán parametr NoClobber , příkaz selže, pokud soubor Alias.csv již v aktuálním adresáři existuje.

Příklad 3: Připojení aliasů k souboru

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

Tento příkaz připojí aliasy v aktuální relaci k souboru Alias.csv.

Příkaz použije parametr Description k přidání popisu do komentářů v horní části souboru.

Příkaz také pomocí parametru Force přepíše všechny existující soubory Alias.csv, i když mají atribut jen pro čtení.

Příklad 4: Export aliasů jako skriptu

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

Tento příklad ukazuje, jak používat formát souboru skriptu, který Export-Alias generuje.

První příkaz exportuje aliasy v relaci do souboru Alias.ps1. Pomocí parametru As s hodnotou Script vygeneruje soubor, který obsahuje příkaz Set-Alias pro každý alias.

Druhý příkaz přidá aliasy v souboru Alias.ps1 do profilu CurrentUser-CurrentHost. Cesta k profilu se uloží do $Profile proměnné. Tento příkaz pomocí Get-Content rutiny získá aliasy ze souboru Alias.ps1 a rutiny Add-Content k jejich přidání do profilu. Další informace najdete v tématu about_Profiles.

Třetí a čtvrtý příkazy přidají aliasy v souboru Alias.ps1 do vzdálené relace na počítači Server01. Třetí příkaz používá rutinu New-PSSession k vytvoření relace. Čtvrtý příkaz používá parametr FilePath rutiny Invoke-Command ke spuštění souboru Alias.ps1 v nové relaci.

Parametry

-Append

Označuje, že tato rutina připojí výstup k zadanému souboru místo přepsání existujícího obsahu tohoto souboru.

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

-As

Určuje výstupní formát. Sdílený svazek clusteru je výchozí. Tento parametr přijímá tyto hodnoty:

  • CSV. Formát hodnot oddělených čárkami (CSV).
  • Skript. Set-Alias Vytvoří příkaz pro každý exportovaný alias. Pokud pojmenujete výstupní soubor s příponou názvu souboru .ps1, můžete ho spustit jako skript pro přidání aliasů do jakékoli relace.
Type:ExportAliasFormat
Accepted values:Csv, Script
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

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

-Description

Určuje popis exportovaného souboru. Popis se zobrazí jako komentář v horní části souboru za informacemi záhlaví.

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

-Force

Vynutí spuštění příkazu bez výzvy k potvrzení uživatele.

Přepíše výstupní soubor, i když je u souboru nastavený atribut jen pro čtení.

Ve výchozím nastavení Export-Alias přepíše soubory bez upozornění, pokud není nastavený atribut jen pro čtení nebo skrytý atribut nebo se v příkazu použije parametr NoClobber . Parametr NoClobber má přednost před parametrem Force , pokud se oba používají v příkazu.

Parametr Force nemůže vynutit Export-Alias přepsání souborů skrytým atributem.

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

-LiteralPath

Určuje cestu k výstupnímu souboru. Na rozdíl od cesty se hodnota parametru LiteralPath používá přesně tak, jak je zadána. Žádné znaky nejsou interpretovány jako zástupné znaky. Pokud cesta obsahuje řídicí znaky, uzavřete ji do jednoduchých uvozovek. Jednoduché uvozovky říkají PowerShellu, aby nepřekládaly žádné znaky jako řídicí sekvence.

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

-Name

Určuje názvy jako pole aliasů, které se mají exportovat. Jsou povoleny zástupné cardy.

Ve výchozím nastavení Export-Alias exportuje všechny aliasy v relaci nebo oboru.

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

-NoClobber

Označuje, že tato rutina zabraňuje Export-Alias přepsání všech souborů, i když se v příkazu použije parametr Force .

Pokud parametr NoClobber vynecháte, Export-Alias přepíše existující soubor bez upozornění, pokud není atribut jen pro čtení nastaven v souboru. NoClobber má přednost před parametrem Force , který umožňuje Export-Alias přepsat soubor atributem jen pro čtení.

NoClobber nezabrání přidání obsahu do existujícího souboru parametru Append .

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

-PassThru

Vrátí objekt představující položku, se kterou pracujete. Ve výchozím nastavení tato rutina negeneruje žádný výstup.

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

-Path

Určuje cestu k výstupnímu souboru. Jsou povoleny zástupné cardy, ale výsledná hodnota cesty se musí přeložit na jeden název souboru.

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

-Scope

Určuje obor, ze kterého mají být aliasy exportovány. Tento parametr přijímá tyto hodnoty:

  • Globální
  • Místní
  • Skript
  • Číslo relativní k aktuálnímu oboru (0 až počet oborů, kde 0 je aktuální obor a 1 je jeho nadřazený)

Výchozí hodnota je Místní. Další informace najdete v tématu about_Scopes.

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

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.

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

Vstupy

None

Do této rutiny nemůžete roušit objekty.

Výstupy

None

Ve výchozím nastavení tato rutina nevrací žádný výstup.

AliasInfo

Pokud použijete parametr PassThru , vrátí tato rutina objekt AliasInfo představující alias.

Poznámky

PowerShell obsahuje následující aliasy pro Export-Alias:

  • Všechny platformy:
    • epal
  • Do souboru můžete exportovat pouze aliasy.