Delen via

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, wordt het door de cmdlet gemaakt.

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

Voorbeelden

Voorbeeld 1: Een alias exporteren

Export-Alias -Path "alias.csv"

Met deze opdracht worden de huidige aliasgegevens geëxporteerd 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 in de huidige map bestaat.

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 maakt ook gebruik van de parameter Force om bestaande Alias.csv bestanden te overschrijven, zelfs als deze 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.

De eerste opdracht exporteert de aliassen in de sessie naar het Alias.ps1-bestand. De parameter As met de waarde Script wordt gebruikt 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_Profiles voor meer informatie.

Met de derde en vierde opdracht 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 gebruikt de FilePath-parameter van de Invoke-Command cmdlet om het Alias.ps1-bestand 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. Indeling van door komma's gescheiden waarden (CSV).
  • Script. Hiermee maakt u een Set-Alias opdracht voor elke geëxporteerde alias. Als u het uitvoerbestand de naam .ps1 bestandsextensie geeft, kunt u het uitvoeren als een script om de aliassen toe te voegen aan een 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 headerinformatie.

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

-Force

Hiermee wordt de opdracht uitgevoerd zonder dat om bevestiging van de gebruiker wordt gevraagd.

Het uitvoerbestand wordt overschreven, zelfs als het kenmerk Alleen-lezen is ingesteld voor 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 niet afdwingen Export-Alias dat bestanden met het verborgen kenmerk worden overschreven.

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. Geen tekens worden geïnterpreteerd als jokertekens. Als het pad escape-tekens bevat, plaatst u het tussen enkele aanhalingstekens. Enkele aanhalingstekens geven PowerShell aan dat geen tekens als escape-reeksen 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.

Standaard exporteert Export-Alias u 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 dat Export-Alias bestanden worden overschreven, zelfs als de parameter Force wordt gebruikt in de opdracht.

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

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 vertegenwoordigt 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 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 en met het aantal bereiken waarbij 0 het huidige bereik is en 1 het bovenliggende bereik)

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 doorspezen naar deze cmdlet.

Uitvoerwaarden

None or System.Management.Automation.AliasInfo

Wanneer u de parameter Passthru gebruikt, Export-Alias wordt een System.Management.Automation.AliasInfo-object geretourneerd dat de alias vertegenwoordigt. Anders genereert deze cmdlet geen uitvoer.

Notities

  • U kunt alleen Export-Aliases naar een bestand.