Export-Alias

Référence

Module:: Microsoft.PowerShell.Utility

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

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

L’applet Export-Alias de commande exporte les alias dans 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 dans une étendue particulière ou toutes les étendues, il peut générer les données au format CSV ou en tant que 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 dans 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 dans un fichier Alias.csv.

Comme le paramètre NoClobber est spécifié, la commande échoue si un fichier Alias.csv existe déjà dans le répertoire actuel.

Exemple 3 : Ajouter des alias à un fichier

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

Cette commande ajoute les alias dans 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 qui Export-Alias génère.

La première commande exporte les alias dans la session dans 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 $Profile variable. La commande utilise l’applet Get-Content de commande pour obtenir les alias du fichier Alias.ps1 et l’applet Add-Content de commande 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 distante sur l’ordinateur Server01. La troisième commande utilise l’applet New-PSSession de commande pour créer la session. La quatrième commande utilise le paramètre FilePath de l’applet Invoke-Command de commande 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é, plutôt que de remplacer le contenu existant de ce fichier.

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

-As

Spécifie le format de sortie. CSV est le format par défaut. Les valeurs valides pour ce paramètre sont :

CSV. Format de valeurs séparées par des virgules (CSV).
Script. Crée une Set-Alias commande pour chaque alias exporté. Si vous nommez le fichier de sortie avec une extension de nom de fichier .ps1, vous pouvez l'exécuter comme un script pour ajouter les alias à toute session.

Type:	ExportAliasFormat
Accepted values:	Csv, Script
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Spécifie la description du fichier exporté. La description s'affiche en tant que commentaire en haut du fichier, après les informations d'en-tête.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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 forcer Export-Alias à remplacer les fichiers avec l’attribut masqué.

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

-LiteralPath

Spécifie le chemin d'accès au fichier de sortie. Contrairement au paramètre Path, la valeur du paramètre LiteralPath est utilisée exactement telle qu'elle est tapée. 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 les caractères comme séquences d’échappement.

Type:	String
Aliases:	PSPath, LP
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Spécifie les noms sous forme de 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.

Type:	String[]
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	True

-NoClobber

Indique que cette applet de commande empêche Export-Alias de remplacer les fichiers, même si le paramètre Force est utilisé dans la commande.

Si le paramètre NoClobber est omis, remplace un fichier existant sans avertissement, Export-Alias 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.

Type:	SwitchParameter
Aliases:	NoOverwrite
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

Retourne un objet représentant l’élément que vous utilisez. Par défaut, cette applet de commande ne génère aucun résultat.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

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

-Scope

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

Global
Local
Script
Nombre relatif à l’étendue actuelle (0 au nombre d’étendues où 0 est l’étendue actuelle et 1 est son parent)

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

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

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entrées

None.

Vous ne pouvez pas rediriger des objets vers cette applet de commande.

Sorties

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

Notes

Vous pouvez uniquement exporter des alias vers un fichier.