Export-Alias

Ссылка

Модуль:: Microsoft.PowerShell.Utility

Экспортирует сведения об определенных на текущий момент псевдонимах в файл.

Синтаксис

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

Описание

Командлет Export-Alias экспортирует псевдонимы в текущем сеансе в файл. Если файл вывода не существует, командлет его создаст.

Export-Aliasможет экспортировать псевдонимы в определенной область или во всех областях, может создавать данные в формате CSV или в виде ряда Set-Alias команд, которые можно добавить в сеанс или в профиль PowerShell.

Примеры

Пример 1. Экспорт псевдонима

Export-Alias -Path "alias.csv"

Эта команда экспортирует текущие сведения о псевдонимах в файл Alias.csv, находящийся в текущем каталоге.

Пример 2. Экспорт псевдонима, если файл экспорта еще не существует

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

Эта команда экспортирует псевдонимы текущего сеанса в файл Alias.csv.

Так как указан параметр NoClobber , команда завершится ошибкой, если файл Alias.csv уже существует в текущем каталоге.

Пример 3. Добавление псевдонимов в файл

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

Эта команда добавляет псевдонимы текущего сеанса в файл Alias.csv.

Команда использует параметр Description для добавления описания к комментариям в верхней части файла.

Команда также использует параметр Force для перезаписи всех существующих файлов Alias.csv, даже если они имеют атрибут только для чтения.

Пример 4. Экспорт псевдонимов в виде скрипта

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

В этом примере показано, как использовать создаваемый формат Export-Alias файла скрипта.

Первая команда экспортирует псевдонимы текущего сеанса в файл Alias.ps1. Он использует параметр As со значением Script для создания файла, содержащего команду Set-Alias для каждого псевдонима.

Вторая команда добавляет псевдонимы из файла Alias.ps1 к профилю CurrentUser-CurrentHost. Путь к профилю сохраняется в переменной $Profile . Команда использует Get-Content командлет для получения псевдонимов из файла Alias.ps1 и командлет , Add-Content чтобы добавить их в профиль. Дополнительные сведения см. в разделе about_Profiles.

Третья и четвертая команды добавляют псевдонимы в файле Alias.ps1 в удаленный сеанс на компьютере Server01. Третья команда использует New-PSSession командлет для создания сеанса. Четвертая команда использует параметр FilePath командлета Invoke-Command для запуска файла Alias.ps1 в новом сеансе.

Параметры

-Append

Указывает, что этот командлет добавляет выходные данные в указанный файл, а не перезаписывает существующее содержимое этого файла.

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

-As

Задает формат вывода. По умолчанию используется формат CSV. Допустимые значения для этого параметра:

CSV. формат значений, разделенных запятыми (CSV).
Скрипт. Set-Alias Создает команду для каждого экспортированного псевдонима. Если выходной файл имеет расширение PS1, его можно запускать в качестве скрипта для добавления псевдонимов к любому сеансу.

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

-Confirm

Запрос подтверждения перед выполнением командлета.

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

-Description

Указывает описание экспортированного файла. Описание добавляется в виде комментария в начало файла после заголовка.

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

-Force

Принудительное выполнение команды без запроса на подтверждение пользователем.

Перезаписывает выходной файл, даже если для него установлен атрибут «только для чтения».

По умолчанию Export-Alias перезаписывает файлы без предупреждения, если не задан атрибут только для чтения или скрытый атрибут или в команде не используется параметр NoClobber . Параметр NoClobber имеет приоритет над параметром Force , если оба параметра используются в команде.

Параметр Force не может принудительно Export-Alias перезаписывать файлы с помощью скрытого атрибута.

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

-LiteralPath

Указывает путь к выходному файлу. В отличие от параметра Path, значение параметра LiteralPath используется в точности так, как вводится. Никакие символы не интерпретируются как знаки подстановки. Если путь содержит escape-символы, заключите его в одинарные кавычки. Одинарные кавычки предписывают PowerShell не интерпретировать какие-либо символы как escape-последовательности.

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

-Name

Задает имена в виде массива псевдонимов для экспорта. Разрешено использовать подстановочные знаки.

По умолчанию Export-Alias экспортирует все псевдонимы в сеансе или область.

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

-NoClobber

Указывает, что этот командлет не позволяет Export-Alias перезаписывать файлы, даже если в команде используется параметр Force .

Если параметр NoClobber опущен, Export-Alias перезапишет существующий файл без предупреждения, если в файле не задан атрибут только для чтения. NoClobber имеет приоритет над параметром Force , который позволяет Export-Alias перезаписать файл атрибутом только для чтения.

NoClobber не запрещает параметру Append добавлять содержимое в существующий файл.

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

-PassThru

Возвращает объект, представляющий элемент, с которым вы работаете. По умолчанию этот командлет не создает выходные данные.

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

-Path

Указывает путь к выходному файлу. Знаки подстановки использовать можно, но итоговое значение пути должно указывать только на одно имя файла.

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

-Scope

Задает область, из которой должны быть экспортированы псевдонимы. Допустимые значения для этого параметра:

Глобальный
Local
Скрипт
Число относительно текущего область (от 0 до числа областей, где 0 — это текущий область, а 1 — родительский элемент).

По умолчанию используется значение Local. Дополнительные сведения см. в разделе about_Scopes.

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

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

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

Входные данные

None.

Нельзя передать объекты в этот командлет с помощью конвейера.

Выходные данные

None or System.Management.Automation.AliasInfo

При использовании параметра Passthru возвращает объект System.Management.Automation.AliasInfo, Export-Alias представляющий псевдоним. В противном случае командлет не формирует никаких выходных данных.

Примечания

Командлет Export-Alias можно применять только для экспорта в файл.