Export-Alias
Exporte vers un fichier les informations sur les alias actuellement définis.
Syntaxe
Export-Alias [-Path] <string> [[-Name] <string[]>] [-Append] [-As {<Csv> | <Script>}] [-Description <string>] [-Force] [-NoClobber] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
Description
L'applet de commande Export-Alias exporte les alias de la session active vers un fichier. Si le fichier de sortie n'existe pas, l'applet de commande le crée.
Export-Alias peut exporter les alias d'une portée spécifique ou de toutes les portées. Elle peut générer les données au format CSV ou sous la forme d'une série de commandes Set-Alias que vous pouvez ajouter à une session ou à un profil Windows PowerShell.
Paramètres
-Append
Ajoute la sortie au fichier spécifié, au lieu de remplacer le contenu existant de ce fichier.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
|
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-As <ExportAliasFormat>
Détermine le format de sortie. La valeur par défaut est CSV.
Les valeurs valides sont :
-- CSV : format de valeurs séparées par des virgules(CSV).
-- Script : crée une commande Set-Alias pour chaque alias exporté. Si vous affectez au fichier de sortie une extension .ps1, vous pouvez l'exécuter en tant que script pour ajouter les alias à n'importe quelle session.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
|
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-Description <string>
Ajoute une description au fichier exporté. La description apparaît sous la forme d'un commentaire au début du fichier, après les informations d'en-tête.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
|
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-Force
Remplace le fichier de sortie, même si l'attribut de lecture seule est défini sur ce fichier.
Par défaut, Export-Alias écrase les fichiers sans avertissement, à moins que l'attribut de lecture seule ou masqué soit défini, ou que le paramètre NoClobber soit 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 forcer Export-Alias à écraser des fichiers avec l'attribut caché.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
Does not overwrite read-only files. |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-Name <string[]>
Spécifie les noms des alias à exporter. Les caractères génériques sont autorisés.
Par défaut, Export-Alias exporte tous les alias de la session ou portée.
Obligatoire ? |
false |
Position ? |
2 |
Valeur par défaut |
Export all aliases |
Accepter l'entrée de pipeline ? |
true (ByPropertyName) |
Accepter les caractères génériques ? |
false |
-NoClobber
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 écrase les fichiers existants sans avertissement, à moins que l'attribut de lecture seule ne soit défini sur le fichier. Le paramètre NoClobber est prioritaire sur le paramètre Force, ce qui permet à Export-Alias d'écraser un fichier possédant l'attribut de lecture seule.
Le paramètre NoClobber n'empêche pas le paramètre Append d'ajouter du contenu à un fichier existant.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
Overwrites read-write files. |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-PassThru
Retourne des objets qui représentent les alias exportés. Par défaut, cette applet de commande ne génère aucune sortie.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
No output |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-Path <string>
Spécifie le chemin d'accès au fichier de sortie. Vous pouvez utiliser des caractères génériques, mais la valeur de chemin d'accès obtenue doit se traduire par un nom de fichier unique. Ce paramètre est obligatoire.
Obligatoire ? |
true |
Position ? |
1 |
Valeur par défaut |
aucun |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-Scope <string>
Spécifie la portée à partir de laquelle les alias doivent être exportés.
Les valeurs valides sont « Global », « Local » ou « Script », ou un nombre relatif à la portée actuelle (de 0 jusqu'au nombre de portées, où 0 est la portée actuelle et 1 son parent). « Local » est la valeur par défaut. Pour plus d'informations, consultez about_Scopes.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
Local |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-Confirm
Vous invite à confirmer l'exécution de la commande.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
|
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-WhatIf
Décrit le résultat que vous obtiendriez en exécutant la commande, sans réellement l'exécuter.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
|
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.
Entrées et sorties
Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.
Entrées |
Aucun. Vous ne pouvez pas diriger d'objets vers cette applet de commande. |
Sorties |
Aucun ou System.Management.Automation.AliasInfo Lorsque vous utilisez le paramètre Passthru, Export-Alias retourne un objet System.Management.Automation.AliasInfo qui représente l'alias. Sinon, cette applet de commande ne génère aucune sortie. |
Remarques
Vous pouvez uniquement exporter les alias (Export-Alias) vers un fichier.
Exemple 1
C:\PS>export-alias -path alias.csv
Description
-----------
Cette commande exporte les informations d'alias existantes vers un fichier intitulé Alias.csv situé dans le répertoire actif.
Exemple 2
C:\PS>export-alias -path alias.csv -noclobber
Description
-----------
Cette commande exporte les alias de la session active vers un fichier Alias.csv.
Dans la mesure où 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
C:\PS>export-alias -path alias.csv -append -description "Appended Aliases" -force
Description
-----------
Cette commande ajoute les alias de la session active au fichier Alias.csv.
Elle utilise le paramètre Description pour ajouter une description aux commentaires au début du fichier.
Elle utilise également le paramètre Force pour écraser les éventuels fichiers Alias.csv existants, même s'ils possèdent l'attribut de lecture seule.
Exemple 4
C:\PS>export-alias -path alias.ps1 -as script
C:\PS> add-content -path $profile -value (get-content alias.ps1)
C:\PS> $s = new-pssession -computername Server01
C:\PS> invoke-command -session $s -filepath .\alias.ps1
Description
-----------
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. Elle utilise le paramètre As avec une valeur de Script pour générer un fichier contenant une commande Set-Alias pour chaque alias.
La deuxième commande ajoute les alias du fichier Alias.ps1 au profil CurrentUser-CurrentHost. (Le chemin d'accès au profil est enregistré dans la variable $profil.) 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.
La troisième et la quatrième commandes ajoutent les alias du 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.