Delen via


Export-Alias

Hiermee exporteert u informatie over momenteel gedefinieerde aliassen naar een bestand.

Syntaxis

ByPath (Standaard)

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

De Export-Alias cmdlet exporteert de aliassen in de huidige sessie naar een bestand. Als het uitvoerbestand niet bestaat, maakt de cmdlet het.

Export-Alias kan de aliassen in een bepaald bereik of in alle bereiken exporteren en kan de gegevens genereren in CSV-indeling of als een reeks Set-Alias-opdrachten die u aan een sessie of een PowerShell-profiel kunt toevoegen.

Voorbeelden

Voorbeeld 1: Een alias exporteren

Export-Alias -Path "Alias.csv"

Met deze opdracht exporteert u de huidige aliasgegevens naar een bestand met de naam Alias.csv in de huidige map.

Voorbeeld 2: Een alias exporteren tenzij het exportbestand al bestaat

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

Met deze opdracht worden de aliassen in de huidige sessie geëxporteerd naar een Alias.csv-bestand.

Omdat de parameter NoClobber is opgegeven, mislukt de opdracht als er al een Alias.csv bestand bestaat in de huidige map.

Voorbeeld 3: Aliassen toevoegen aan een bestand

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

Met deze opdracht worden de aliassen in de huidige sessie toegevoegd aan het Alias.csv-bestand.

De opdracht gebruikt de parameter Description om een beschrijving toe te voegen aan de opmerkingen boven aan het bestand.

De opdracht gebruikt ook de parameter Force om bestaande Alias.csv bestanden te overschrijven, zelfs als ze het kenmerk alleen-lezen hebben.

Voorbeeld 4: Aliassen exporteren als een 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

In dit voorbeeld ziet u hoe u de scriptbestandsindeling gebruikt die Export-Alias genereert.

Met de eerste opdracht worden de aliassen in de sessie geëxporteerd naar het Alias.ps1-bestand. Deze maakt gebruik van de parameter As met de waarde Script om een bestand te genereren dat een Set-Alias opdracht voor elke alias bevat.

Met de tweede opdracht worden de aliassen in het Alias.ps1-bestand toegevoegd aan het CurrentUser-CurrentHost-profiel. Het pad naar het profiel wordt opgeslagen in de $PROFILE variabele. De opdracht gebruikt de Get-Content cmdlet om de aliassen op te halen uit het Alias.ps1 bestand en de Add-Content cmdlet om ze toe te voegen aan het profiel. Zie about_Profilesvoor meer informatie.

Met de derde en vierde opdrachten worden de aliassen in het Alias.ps1-bestand toegevoegd aan een externe sessie op de Server01-computer. De derde opdracht maakt gebruik van de New-PSSession cmdlet om de sessie te maken. De vierde opdracht maakt gebruik van de parameter FilePath- van de Invoke-Command-cmdlet om het Alias.ps1-bestand in de nieuwe sessie uit te voeren.

Parameters

-Append

Geeft aan dat deze cmdlet de uitvoer toevoegt aan het opgegeven bestand, in plaats van de bestaande inhoud van dat bestand te overschrijven.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-As

Geeft het uitvoerformaat op. CSV is de standaardwaarde. De acceptabele waarden voor deze parameter zijn:

  • CSV. Csv-indeling (door komma's gescheiden waarden).
  • Script. Hiermee maakt u een Set-Alias opdracht voor elke geëxporteerde alias. Als u het uitvoerbestand een naam krijgt met een .ps1 bestandsnaamextensie, kunt u het uitvoeren als een script om de aliassen toe te voegen aan een sessie.

Parametereigenschappen

Type:ExportAliasFormat
Default value:None
Geaccepteerde waarden:Csv, Script
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Confirm

Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Cf

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Description

Hiermee geeft u de beschrijving van het geëxporteerde bestand. De beschrijving wordt weergegeven als een opmerking boven aan het bestand, na de koptekstinformatie.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Force

Hiermee dwingt u de opdracht uit te voeren zonder dat u om bevestiging van de gebruiker wordt gevraagd.

Hiermee wordt het uitvoerbestand overschreven, zelfs als het kenmerk Alleen-lezen is ingesteld op het bestand.

Standaard overschrijft Export-Alias bestanden zonder waarschuwing, tenzij het kenmerk alleen-lezen of verborgen is ingesteld of de parameter NoClobber wordt gebruikt in de opdracht. De parameter NoClobber heeft voorrang op de parameter Force wanneer beide worden gebruikt in een opdracht.

De parameter Forceren kan niet afdwingen dat Export-Alias bestanden overschrijft met het verborgen kenmerk.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-LiteralPath

Geeft het pad naar het uitvoerbestand op. In tegenstelling tot Pad, wordt de waarde van de parameter LiteralPath exact gebruikt zoals deze is getypt. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escape-tekens bevat, zet het dan tussen enkele aanhalingstekens. Enkele aanhalingstekens zorgen ervoor dat PowerShell geen tekens als escapesequenties interpreteert.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:PSPath, LP

Parametersets

ByLiteralPath
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-Name

Hiermee geeft u de namen op als een matrix van de aliassen die moeten worden geëxporteerd. Wildcards zijn toegestaan.

Volgens standaardgedrag exporteert Export-Alias alle aliassen in de sessie of de scope.

Parametereigenschappen

Type:

String[]

Default value:None
Ondersteunt jokertekens:True
DontShow:False

Parametersets

(All)
Position:1
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-NoClobber

Geeft aan dat deze cmdlet voorkomt dat Export-Alias bestanden overschrijft, zelfs als de parameter Force wordt gebruikt in de opdracht.

Als de parameter NoClobber- wordt weggelaten, overschrijft Export-Alias een bestaand bestand zonder waarschuwing, tenzij het kenmerk Alleen-lezen is ingesteld op het bestand. NoClobber- heeft voorrang op de parameter Force, waarmee Export-Alias een bestand met het kenmerk Alleen-lezen kan overschrijven.

NoClobber verhindert niet dat de parameter Append inhoud aan een bestaand bestand toevoegt.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:NoOverwrite

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-PassThru

Retourneert een object dat het item aangeeft waarmee u werkt. Deze cmdlet genereert standaard geen uitvoer.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Path

Geeft het pad naar het uitvoerbestand op. Jokertekens zijn toegestaan, maar de resulterende padwaarde moet worden omgezet in één bestandsnaam.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:True
DontShow:False

Parametersets

ByPath
Position:0
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Scope

Hiermee geeft u het bereik van waaruit de aliassen moeten worden geëxporteerd. De acceptabele waarden voor deze parameter zijn:

  • Global
  • Local
  • Script
  • Een getal relatief ten opzichte van het huidige niveau (0 tot het aantal niveaus waarbij 0 het huidige niveau is en 1 het bovenliggende niveau is)

De standaardwaarde is Local. Zie about_Scopesvoor meer informatie.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-WhatIf

Toont wat er zou gebeuren wanneer de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Wi

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

None

U kunt geen objecten doorsluisen naar deze cmdlet.

Uitvoerwaarden

None

Deze cmdlet retourneert standaard geen uitvoer.

AliasInfo

Wanneer u de parameter PassThru gebruikt, retourneert deze cmdlet een AliasInfo--object dat de alias vertegenwoordigt.

Notities

PowerShell bevat de volgende aliassen voor Export-Alias:

  • Alle platforms:
    • epal
  • U kunt alleen Export-Aliases naar een file uitvoeren.