Export-Alias

  • Referentie
Module:
Microsoft.PowerShell.Utility

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

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

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, de gegevens in CSV-indeling of als een reeks setaliasopdrachten die u aan een sessie of aan 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 wordt gegenereerd.

Met de eerste opdracht worden de aliassen in de sessie geëxporteerd naar het Alias.ps1-bestand. De parameter As wordt gebruikt met de waarde Script om een bestand te genereren dat een setaliasopdracht voor elke alias bevat.

Met de tweede opdracht worden de aliassen in het bestand Alias.ps1 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 deze toe te voegen aan het profiel. Zie about_Profiles voor meer informatie.

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

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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-As

Hiermee geeft u de indeling van de uitvoer. CSV is de standaardwaarde. De aanvaardbare 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 de bestandsextensie .ps1, kunt u het uitvoeren als een script om de aliassen toe te voegen aan elke sessie.
Type:ExportAliasFormat
Accepted values:Csv, Script
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Export-Alias Standaard worden bestanden zonder waarschuwing overschreven, 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 Force kan geen Export-Alias bestanden met het verborgen kenmerk overschrijven.

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

-LiteralPath

Hiermee geeft u het pad naar het uitvoerbestand. In tegenstelling tot Path wordt de waarde van de parameter LiteralPath precies 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
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

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

Exporteert standaard Export-Alias alle aliassen in de sessie of het bereik.

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

-NoClobber

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

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

NoClobber voorkomt niet dat de parameter Toevoegen inhoud toevoegt aan een bestaand bestand.

Type:SwitchParameter
Aliases:NoOverwrite
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Hiermee geeft u 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
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-Scope

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

  • Globaal
  • Lokaal
  • Script
  • Een getal ten opzichte van het huidige bereik (0 tot het aantal bereiken waarbij 0 het huidige bereik is en 1 het bovenliggende bereik is)

De standaardwaarde is Lokaal. Zie about_Scopes voor meer informatie.

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

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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 exportaliassen naar een bestand.