Delen via

Export-Alias

  • Referentie
Module:
Microsoft.PowerShell.Utility

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

Syntaxis

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

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 alle bereiken exporteren, en het 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.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-As

Bepaal de uitvoerindeling. 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 geeft met een .ps1-bestandsnaamextensie, kunt u het uitvoeren als een script om de aliassen toe te voegen aan elke sessie.
Type:ExportAliasFormat
Geaccepteerde waarden:Csv, Script
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Confirm

U wordt gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:SwitchParameter
Aliassen:cf
Position:Named
Default value:False
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren: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.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren: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.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-LiteralPath

Dit specificeert het pad naar het uitvoerbestand. 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 escapetekens bevat, plaatst u het tussen enkele aanhalingstekens. Enkele aanhalingstekens geven PowerShell aan dat er geen tekens als escapereeksen moeten worden geïnterpreteerd.

Type:String
Aliassen:PSPath, LP
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Name

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

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

Type:String[]
Position:1
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:True

-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- voorkomt niet dat de parameter Append inhoud toevoegt aan een bestaand bestand.

Type:SwitchParameter
Aliassen:NoOverwrite
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Path

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

Type:String
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:True

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

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-WhatIf

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

Type:SwitchParameter
Aliassen:wi
Position:Named
Default value:False
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

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 bestand.