Export-Alias

Modul:

Microsoft.PowerShell.Utility Module

Exportiert Informationen zu aktuell definierten Aliasen in eine Datei.

Syntax

ByPath (Standard)

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

Beschreibung

Das Export-Alias Cmdlet exportiert die Aliase in der aktuellen Sitzung in eine Datei. Wenn die Ausgabedatei nicht vorhanden ist, erstellt das Cmdlet sie.

Export-Alias kann die Aliase in einem bestimmten Bereich oder allen Bereichen exportieren, sie können die Daten im CSV-Format oder als Eine Reihe von Set-Alias Befehlen generieren, die Sie einer Sitzung oder einem PowerShell-Profil hinzufügen können.

Beispiele

Beispiel 1: Exportieren eines Alias

Export-Alias -Path Alias.csv

Mit diesem Befehl werden aktuelle Aliasinformationen in eine Datei exportiert, die im aktuellen Verzeichnis benannt ist Alias.csv .

Beispiel 2: Exportieren eines Alias, es sei denn, die Exportdatei ist bereits vorhanden

Export-Alias -Path Alias.csv -NoClobber

Mit diesem Befehl werden die Aliase in der aktuellen Sitzung in eine Alias.csv Datei exportiert.

Da der Parameter NoClobber angegeben ist, schlägt der Befehl fehl, wenn bereits eine Alias.csv Datei im aktuellen Verzeichnis vorhanden ist.

Beispiel 3: Anfügen von Aliasen an eine Datei

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

Mit diesem Befehl werden die Aliase in der aktuellen Sitzung an die Alias.csv Datei angefügt.

Der Befehl verwendet den Parameter "Description ", um den Kommentaren oben in der Datei eine Beschreibung hinzuzufügen.

Der Befehl verwendet auch den Parameter Force , um vorhandene Alias.csv Dateien zu überschreiben, auch wenn sie über das schreibgeschützte Attribut verfügen.

Beispiel 4: Exportieren von Aliasen als Skript

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

In diesem Beispiel wird gezeigt, wie Sie das generierte Export-Alias Skriptdateiformat verwenden.

Der erste Befehl exportiert die Aliase in der Sitzung in die Alias.ps1 Datei. Er verwendet den Parameter "As " mit dem Wert "Script", um eine Datei zu generieren, die einen Set-Alias Befehl für jeden Alias enthält.

Mit dem zweiten Befehl werden dem CurrentUser-CurrentHost Profil die Aliase in der Alias.ps1 Datei hinzugefügt. Der Pfad zum Profil wird in der $PROFILE Variablen gespeichert. Der Befehl verwendet das Get-Content Cmdlet, um die Aliase aus der Alias.ps1-Datei und dem Add-Content Cmdlet abzurufen, um sie dem Profil hinzuzufügen. Weitere Informationen finden Sie unter about_Profiles.

Die dritten und vierten Befehle fügen die Aliase in der Alias.ps1-Datei zu einer Remotesitzung auf dem Server01-Computer hinzu. Der dritte Befehl verwendet das New-PSSession Cmdlet zum Erstellen der Sitzung. Der vierte Befehl verwendet den FilePath-Parameter des Invoke-Command Cmdlets, um die Alias.ps1 Datei in der neuen Sitzung auszuführen.

Parameter

-Append

Gibt an, dass dieses Cmdlet die Ausgabe an die angegebene Datei angibt, anstatt den vorhandenen Inhalt dieser Datei zu überschreiben.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-As

Gibt das Ausgabeformat an. CSV ist die Standardeinstellung. Die zulässigen Werte für diesen Parameter sind:

• CSV. CSV-Format (Kommagetrennte Werte).
• Skript. Erstellt einen Set-Alias Befehl für jeden exportierten Alias. Wenn Sie die Ausgabedatei mit einer .ps1 Dateinamenerweiterung benennen, können Sie sie als Skript ausführen, um die Aliase einer beliebigen Sitzung hinzuzufügen.

Parametereigenschaften

Typ:	ExportAliasFormat
Standardwert:	None
Zulässige Werte:	Csv, Script
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	False
Unterstützt Platzhalter:	False
Nicht anzeigen:	False
Aliase:	Cf

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Description

Gibt die Beschreibung der exportierten Datei an. Die Beschreibung wird oben in der Datei als Kommentar angezeigt und folgt den Kopfzeileninformationen.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Force

Erzwingt die Ausführung des Befehls, ohne eine Benutzerbestätigung zu verlangen.

Überschreibt die Ausgabedatei, auch wenn das schreibgeschützte Attribut für die Datei festgelegt ist.

Überschreibt Standardmäßig Dateien ohne Warnung, es sei denn, Export-Alias das schreibgeschützte oder ausgeblendete Attribut wird festgelegt, oder der Parameter NoClobber wird im Befehl verwendet. Der Parameter NoClobber hat Vorrang vor dem Parameter Force , wenn beide in einem Befehl verwendet werden.

Der Force-Parameter kann nicht erzwingen Export-Alias , Dateien mit dem ausgeblendeten Attribut zu überschreiben.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-LiteralPath

Gibt den Pfad zur Ausgabedatei an. Im Gegensatz zu Path wird der Wert des LiteralPath-Parameters genau so verwendet, wie er eingegeben wurde. Es werden keine Zeichen als Wildcards interpretiert. Wenn der Pfad Escapezeichen enthält, müssen Sie ihn in einfache Anführungszeichen einschließen. Einfache Anführungszeichen signalisieren PowerShell, dass keine Zeichen als Escapesequenzen interpretiert werden sollen.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False
Aliase:	PSPath, EP

Parametersätze

ByLiteralPath

Position:	Named
Obligatorisch.:	True
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	True
Wert aus verbleibenden Argumenten:	False

-Name

Gibt die Namen als Array der zu exportierenden Aliase an. Wildcards sind zulässig.

Exportiert standardmäßig Export-Alias alle Aliase in der Sitzung oder im Bereich.

Parametereigenschaften

Typ:	String[]
Standardwert:	None
Unterstützt Platzhalter:	True
Nicht anzeigen:	False

Parametersätze

(All)

Position:	1
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	True
Wert aus verbleibenden Argumenten:	False

-NoClobber

Gibt an, dass dieses Cmdlet das Überschreiben von Dateien verhindert Export-Alias , auch wenn der Parameter Force im Befehl verwendet wird.

Wenn der Parameter NoClobber nicht angegeben wird, Export-Alias überschreibt eine vorhandene Datei ohne Warnung, es sei denn, das schreibgeschützte Attribut wird für die Datei festgelegt. NoClobber hat Vorrang vor dem Force-Parameter , mit dem eine Datei mit dem schreibgeschützten Attribut überschrieben werden kann Export-Alias .

NoClobber verhindert nicht, dass der Append-Parameter Einer vorhandenen Datei Inhalt hinzufügt.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False
Aliase:	NoOverwrite

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-PassThru

Gibt ein Objekt zurück, das das Element darstellt, mit dem Sie arbeiten. Standardmäßig generiert dieses Cmdlet keine Ausgabe.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Path

Gibt den Pfad zur Ausgabedatei an. Wildcards sind zulässig, der resultierende Pfadwert muss jedoch in einen einzelnen Dateinamen aufgelöst werden.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	True
Nicht anzeigen:	False

Parametersätze

ByPath

Position:	0
Obligatorisch.:	True
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Scope

Gibt den Bereich an, aus dem die Aliase exportiert werden sollen. Die zulässigen Werte für diesen Parameter sind:

• Global
• Local
• Script
• Eine Zahl relativ zum aktuellen Bereich (0 bis zur Anzahl der Bereiche, wobei 0 der aktuelle Bereich ist und 1 das übergeordnete Element ist)

Der Standardwert ist Local. Weitere Informationen finden Sie unter about_Scopes.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	False
Unterstützt Platzhalter:	False
Nicht anzeigen:	False
Aliase:	Wi

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

None

Sie können keine Objekte an dieses Cmdlet weiterleiten.

Ausgaben

None

Standardmäßig gibt dieses Cmdlet keine Ausgabe zurück.

AliasInfo

Wenn Sie den PassThru-Parameter verwenden, gibt dieses Cmdlet ein AliasInfo-Objekt zurück, das den Alias darstellt.

Hinweise

PowerShell enthält die folgenden Aliase für Export-Alias:

• Alle Plattformen:
  • epal

• Sie können nur eine Datei Export-Aliases.

Ähnliche Themen

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