Export-Alias
Exportuje informace o aktuálně definovaných aliasech do souboru.
Syntax
ByPath (Výchozí)
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
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 vygenerovat 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.
Protože je zadaný parametr NoClobber, příkaz selže, pokud Alias.csv soubor 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žívá parametr Description k přidání popisu do komentářů v horní části souboru.
Příkaz také používá parametr Force k přepsání všech existujících Alias.csv souborů, 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žít formát souboru skriptu, který Export-Alias vygeneruje.
První příkaz exportuje aliasy v relaci do souboru Alias.ps1. Používá parametr As s hodnotou Script k vygenerování souboru, který obsahuje Set-Alias příkaz pro každý alias.
Druhý příkaz přidá aliasy v souboru Alias.ps1 do profilu CurrentUser-CurrentHost.
Cesta k profilu se uloží do proměnné $Profile.
Příkaz pomocí rutiny Get-Content 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říkaz přidá aliasy v souboru Alias.ps1 do vzdálené relace na počítači Server01.
Třetí příkaz k vytvoření relace používá rutinu New-PSSession.
Č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.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-As
Určuje výstupní formát. Sdílený svazek clusteru je výchozí.
Platné hodnoty jsou:
- CSV: Formát hodnot oddělených čárkami (CSV).
- Skript: Vytvoří Set-Alias 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.
Vlastnosti parametru
| Typ: | ExportAliasFormat |
| Default value: | None |
| Přípustné hodnoty: | Csv, Script |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Confirm
Před spuštěním cmdletu vás vyzve k potvrzení.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | viz |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Description
Určuje popis exportovaného souboru. Popis se zobrazí jako komentář v horní části souboru za informacemi záhlaví.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Force
Přinutí příkaz ke spuštění 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řepsat soubory bez upozornění, pokud není nastaven atribut jen pro čtení nebo skrytý atribut nebo NoClobber parametr se použije v příkazu.
Parametr NoClobber má přednost před parametrem Force při použití obou příkazů.
Parametr Force nemůže vynutit, aby Export-Alias přepsal soubory skrytým atributem.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-LiteralPath
Určuje cestu k výstupnímu souboru. Na rozdíl od Pathse hodnota parametru LiteralPath používá přesně tak, jak je zadán. Žádný znak není interpretován jako zástupný znak. Pokud cesta obsahuje únikové znaky, uzavřete ji do jednoduchých uvozovek. Jednoduché uvozovky říkají PowerShellu, aby žádné znaky neinterpretoval jako únikové sekvence.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | PSPath |
Sady parametrů
ByLiteralPath
| Position: | Named |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-Name
Určuje názvy jako pole aliasů, které se mají exportovat. Jsou povoleny zástupné symboly.
Ve výchozím nastavení Export-Alias exportují všechny aliasy v relaci nebo oboru.
Vlastnosti parametru
| Typ: | String[] |
| Default value: | None |
| Podporuje zástupné znaky: | True |
| DontShow: | False |
Sady parametrů
(All)
| Position: | 1 |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-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 v souboru není nastavený atribut jen pro čtení.
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.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | NoOverwrite |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-PassThru
Vrátí objekt představující položku, se kterou pracujete. Ve výchozím nastavení tato rutina negeneruje žádný výstup.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | 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.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | True |
| DontShow: | False |
Sady parametrů
ByPath
| Position: | 0 |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Scope
Určuje obor, ze kterého mají být aliasy exportovány. Přijatelné hodnoty pro tento parametr jsou:
- Globální
- Místní
- Scénář
- Čí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.
Vlastnosti parametru
| Typ: | String |
| Default value: | Local |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-WhatIf
Ukazuje, co se stane, když se příkaz spustí. Příkazový modul nebyl spuštěn.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | Wi |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
CommonParameters
Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.
Vstupy
None.
Do této rutiny nelze vést objekty.
Výstupy
None or System.Management.Automation.AliasInfo
Pokud použijete parametr Passthru, Export-Alias vrátí objekt System.Management.Automation.AliasInfo, který představuje alias.
Jinak tento příkaz negeneruje žádný výstup.
Poznámky
- Do souboru můžete Export-Aliases.