Dela via

Export-Alias

  • Referens
Modul:
Microsoft.PowerShell.Utility

Exporterar information om för närvarande definierade alias till en fil.

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

Cmdleten Export-Alias exporterar aliasen i den aktuella sessionen till en fil. Om utdatafilen inte finns skapar cmdleten den.

Export-Alias kan exportera aliasen i ett visst omfång eller alla omfång kan de generera data i CSV-format eller som en serie Set-Alias kommandon som du kan lägga till i en session eller i en PowerShell-profil.

Exempel

Exempel 1: Exportera ett alias

Export-Alias -Path "alias.csv"

Det här kommandot exporterar aktuell aliasinformation till en fil med namnet Alias.csv i den aktuella katalogen.

Exempel 2: Exportera ett alias om inte exportfilen redan finns

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

Det här kommandot exporterar aliasen i den aktuella sessionen till en Alias.csv fil.

Eftersom parametern NoClobber anges misslyckas kommandot om det redan finns en Alias.csv fil i den aktuella katalogen.

Exempel 3: Lägga till alias i en fil

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

Det här kommandot lägger till aliasen i den aktuella sessionen i filen Alias.csv.

Kommandot använder parametern Description för att lägga till en beskrivning i kommentarerna överst i filen.

Kommandot använder också parametern Force för att skriva över befintliga Alias.csv filer, även om de har det skrivskyddade attributet.

Exempel 4: Exportera alias som ett 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

Det här exemplet visar hur du använder skriptfilformatet som Export-Alias genererar.

Det första kommandot exporterar aliasen i sessionen till filen Alias.ps1. Den använder parametern Som med värdet Skript för att generera en fil som innehåller ett Set-Alias kommando för varje alias.

Det andra kommandot lägger till aliasen i Alias.ps1-filen i CurrentUser-CurrentHost profilen. Sökvägen till profilen sparas i variabeln $Profile. Kommandot använder cmdleten Get-Content för att hämta aliasen från Alias.ps1-filen och cmdleten Add-Content för att lägga till dem i profilen. Mer information finns i about_Profiles.

De tredje och fjärde kommandona lägger till aliasen i Alias.ps1-filen till en fjärrsession på Server01-datorn. Det tredje kommandot använder cmdleten New-PSSession för att skapa sessionen. Det fjärde kommandot använder parametern FilePath för cmdleten Invoke-Command för att köra filen Alias.ps1 i den nya sessionen.

Parametrar

-Append

Anger att den här cmdleten lägger till utdata till den angivna filen i stället för att skriva över det befintliga innehållet i filen.

Typ:SwitchParameter
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-As

Anger utdataformatet. CSV är standardinställningen.

Giltiga värden är:

  • CSV: Kommaavgränsat värdeformat (CSV).
  • Skript: Skapar ett Set-Alias kommando för varje exporterat alias. Om du namnger utdatafilen med filnamnstillägget .ps1 kan du köra den som ett skript för att lägga till aliasen i valfri session.
Typ:ExportAliasFormat
Godkända värden:Csv, Script
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Typ:SwitchParameter
Alias:cf
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Description

Anger beskrivningen av den exporterade filen. Beskrivningen visas som en kommentar överst i filen, efter rubrikinformationen.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Force

Tvingar kommandot att köras utan att be om användarbekräftelse.

Skriver över utdatafilen, även om det skrivskyddade attributet har angetts för filen.

Som standard skriver Export-Alias över filer utan varning, såvida inte det skrivskyddade eller dolda attributet har angetts eller parametern NoClobber används i kommandot. Parametern NoClobber har företräde framför parametern Force när båda används i ett kommando.

Parametern Force kan inte tvinga Export-Alias att skriva över filer med det dolda attributet.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-LiteralPath

Anger sökvägen till utdatafilen. Till skillnad från Pathanvänds värdet för parametern LiteralPath precis som det skrivs. Inga tecken tolkas som jokertecken. Om sökvägen innehåller escape-tecken omger du den med enkla citattecken. Enkla citattecken gör att PowerShell inte tolkar några tecken som escape-sekvenser.

Typ:String
Alias:PSPath
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Name

Anger namnen som en matris med de alias som ska exporteras. Jokertecken tillåts.

Som standard exporterar Export-Alias alla alias i sessionen eller omfånget.

Typ:String[]
Position:1
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:True

-NoClobber

Anger att den här cmdleten förhindrar att Export-Alias skriver över filer, även om parametern Force används i kommandot.

Om parametern NoClobber utelämnas skriver Export-Alias över en befintlig fil utan varning, såvida inte det skrivskyddade attributet har angetts för filen. NoClobber har företräde framför parametern Force, vilket gör att Export-Alias kan skriva över en fil med det skrivskyddade attributet.

NoClobber hindrar inte parametern Lägg till från att lägga till innehåll i en befintlig fil.

Typ:SwitchParameter
Alias:NoOverwrite
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-PassThru

Returnerar ett objekt som representerar det objekt som du arbetar med. Som standard genererar den här cmdleten inga utdata.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Path

Anger sökvägen till utdatafilen. Jokertecken tillåts, men det resulterande sökvägsvärdet måste matchas till ett enda filnamn.

Typ:String
Position:0
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:True

-Scope

Anger det omfång som aliasen ska exporteras från. De godtagbara värdena för den här parametern är:

  • Global
  • Lokal
  • Manus
  • Ett tal i förhållande till det aktuella omfånget (0 genom antalet omfång där 0 är det aktuella omfånget och 1 är dess överordnade)

Standardvärdet är Lokalt. Mer information finns i about_Scopes.

Typ:String
Position:Named
Standardvärde:Local
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-WhatIf

Visar vad som skulle hända om cmdleten körs. Cmdleten körs inte.

Typ:SwitchParameter
Alias:wi
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

None.

Du kan inte skicka objekt till den här cmdleten.

Utdata

None or System.Management.Automation.AliasInfo

När du använder parametern Passthru returnerar Export-Alias ett System.Management.Automation.AliasInfo-objekt som representerar aliaset. Annars genererar den här cmdleten inga utdata.

Kommentarer

  • Du kan bara Export-Aliases till en fil.