Dela via

Export-Alias

Modul:
Microsoft.PowerShell.Utility Module

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

Syntax

ByPath (Standard) 

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

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, och de kan 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.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-As

Anger utdataformatet. CSV är standardinställningen. De godtagbara värdena för den här parametern är:

  • CSV. CsV-format (Kommaavgränsat värde).
  • Manus. 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.

Parameteregenskaper

Typ:ExportAliasFormat
Standardvärde:None
Godkända värden:Csv, Script
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Confirm

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

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Description

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

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument: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.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument: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 wildcards. 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.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:PSPath, SP

Parameteruppsättningar

ByLiteralPath
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument: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.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:True
DontShow:False

Parameteruppsättningar

(All)
Position:1
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

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

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:NoOverwrite

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-PassThru

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

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Path

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

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:True
DontShow:False

Parameteruppsättningar

ByPath
Position:0
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Scope

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

  • Global
  • Local
  • Script
  • 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 Local. Mer information finns i about_Scopes.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WhatIf

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

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

None

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

Utdata

None

Som standard returnerar den här cmdleten inga utdata.

AliasInfo

När du använder parametern PassThru returnerar den här cmdleten ett AliasInfo--objekt som representerar aliaset.

Kommentarer

PowerShell innehåller följande alias för Export-Alias:

  • Alla plattformar:
    • epal
  • Du kan bara Export-Aliases till en fil.