Export-Alias

Module:

Microsoft.PowerShell.Utility Module

Exporte des informations sur les alias actuellement définis vers un fichier.

Syntaxe

ByPath (Par défaut)

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

L’applet de commande Export-Alias exporte les alias dans la session active vers un fichier. Si le fichier de sortie n’existe pas, l’applet de commande la crée.

Export-Alias peut exporter les alias dans une étendue particulière ou dans toutes les étendues, et peut générer les données sous forme de CSV ou sous forme d'une série de commandes Set-Alias que vous pouvez ajouter à une session ou à un profil PowerShell.

Exemples

Exemple 1 : Exporter un alias

Export-Alias -Path "alias.csv"

Cette commande exporte les informations d’alias actuelles vers un fichier nommé Alias.csv dans le répertoire actif.

Exemple 2 : Exporter un alias, sauf si le fichier d’exportation existe déjà

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

Cette commande exporte les alias dans la session active vers un fichier Alias.csv.

Étant donné que le paramètre NoClobber est spécifié, la commande échoue si un fichier Alias.csv existe déjà dans le répertoire actif.

Exemple 3 : Ajouter des alias à un fichier

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

Cette commande ajoute les alias de la session active au fichier Alias.csv.

La commande utilise le paramètre Description pour ajouter une description aux commentaires en haut du fichier.

La commande utilise également le paramètre Force pour remplacer les fichiers Alias.csv existants, même s’ils ont l’attribut en lecture seule.

Exemple 4 : Exporter des alias en tant que 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

Cet exemple montre comment utiliser le format de fichier de script généré par Export-Alias.

La première commande exporte les alias de la session vers le fichier Alias.ps1. Il utilise le paramètre As avec une valeur de Script pour générer un fichier qui contient une commande Set-Alias pour chaque alias.

La deuxième commande ajoute les alias dans le fichier Alias.ps1 au profil CurrentUser-CurrentHost. Le chemin d’accès au profil est enregistré dans la variable $PROFILE. La commande utilise l’applet de commande Get-Content pour obtenir les alias du fichier Alias.ps1 et l’applet de commande Add-Content pour les ajouter au profil. Pour plus d’informations, consultez about_Profiles.

Les troisième et quatrième commandes ajoutent les alias dans le fichier Alias.ps1 à une session à distance sur l’ordinateur Server01. La troisième commande utilise l’applet de commande New-PSSession pour créer la session. La quatrième commande utilise le paramètre FilePath de l’applet de commande Invoke-Command pour exécuter le fichier Alias.ps1 dans la nouvelle session.

Paramètres

-Append

Indique que cette applet de commande ajoute la sortie au fichier spécifié, au lieu de remplacer le contenu existant de ce fichier.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-As

Spécifie le format de sortie. CSV est la valeur par défaut. Les valeurs acceptables pour ce paramètre sont les suivantes :

• CSV. Format de valeur séparée par des virgules (CSV).
• Script. Crée une commande Set-Alias pour chaque alias exporté. Si vous nommez le fichier de sortie avec une extension de nom de fichier .ps1, vous pouvez l’exécuter en tant que script pour ajouter les alias à n’importe quelle session.

Propriétés du paramètre

Type:	ExportAliasFormat
Valeur par défaut:	None
Valeurs acceptées:	Csv, Script
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	False
Prend en charge les caractères génériques:	False
DontShow:	False
Alias:	cf

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-Description

Spécifie la description du fichier exporté. La description s’affiche sous forme de commentaire en haut du fichier, en suivant les informations d’en-tête.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-Force

Force l’exécution de la commande sans demander la confirmation de l’utilisateur.

Remplace le fichier de sortie, même si l’attribut en lecture seule est défini sur le fichier.

Par défaut, Export-Alias remplace les fichiers sans avertissement, sauf si l’attribut en lecture seule ou masqué est défini ou que le paramètre NoClobber est utilisé dans la commande. Le paramètre NoClobber est prioritaire sur le paramètre Force lorsque les deux sont utilisés dans une commande.

Le paramètre Force ne peut pas obliger Export-Alias à remplacer les fichiers avec l’attribut caché.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-LiteralPath

Spécifie le chemin d’accès au fichier de sortie. Contrairement à Path, la valeur du paramètre LiteralPath est utilisée exactement comme il est typé. Aucun caractère n’est interprété en tant que caractère générique. Si le chemin d’accès inclut des caractères d’échappement, mettez-le entre des guillemets simples. Les guillemets simples indiquent à PowerShell de ne pas interpréter de caractères comme séquences d’échappement.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False
Alias:	PSPath

Jeux de paramètres

ByLiteralPath

Position:	Named
Obligatoire:	True
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	True
Valeur des arguments restants:	False

-Name

Spécifie les noms sous la forme d’un tableau des alias à exporter. Les caractères génériques sont autorisés.

Par défaut, Export-Alias exporte tous les alias dans la session ou l’étendue.

Propriétés du paramètre

Type:	String[]
Valeur par défaut:	None
Prend en charge les caractères génériques:	True
DontShow:	False

Jeux de paramètres

(All)

Position:	1
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	True
Valeur des arguments restants:	False

-NoClobber

Indique que ce cmdlet empêche Export-Alias d’écraser des fichiers, même si le paramètre Force est utilisé dans la commande.

Si le paramètre NoClobber est omis, Export-Alias remplacera un fichier existant sans avertissement, sauf si l’attribut en lecture seule est défini sur le fichier. NoClobber est prioritaire sur le paramètre Force, ce qui permet à Export-Alias de remplacer un fichier avec l’attribut en lecture seule.

NoClobber n’empêche pas le paramètre Append d’ajouter du contenu à un fichier existant.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False
Alias:	NoOverwrite

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-PassThru

Retourne un objet représentant l’élément avec lequel vous travaillez. Par défaut, cette applet de commande ne génère aucune sortie.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-Path

Spécifie le chemin d’accès au fichier de sortie. Les caractères génériques sont autorisés, mais la valeur de chemin d'accès résultante doit être résolue en un seul nom de fichier.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	True
DontShow:	False

Jeux de paramètres

ByPath

Position:	0
Obligatoire:	True
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-Scope

Spécifie l'étendue à partir de laquelle les alias doivent être exportés. Les valeurs acceptables pour ce paramètre sont les suivantes :

• Global
• Local
• Script
• Un nombre relatif à l’étendue actuelle (de 0 jusqu’au nombre d’étendues, où 0 est l’étendue actuelle et 1 est celle de son parent)

La valeur par défaut est Local. Pour plus d’informations, consultez about_Scopes.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	False
Prend en charge les caractères génériques:	False
DontShow:	False
Alias:	Wi

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

None

Vous ne pouvez pas diriger les objets vers cette applet de commande.

Sorties

None

Par défaut, cette applet de commande ne retourne aucune sortie.

AliasInfo

Lorsque vous utilisez le paramètre PassThru , cette applet de commande renvoie un objet aliasInfo représentant l’alias.

Notes

Windows PowerShell inclut les alias suivants pour Export-Alias:

• epal

• Vous pouvez uniquement exporter des alias vers un fichier.

Liens associés

• Get-Alias
• Import-Alias
• New-Alias
• Set-Alias