Export-Alias (Microsoft.PowerShell.Utility)

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

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

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-As

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

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

Тип :: Экспорталиасформат
Принятые значения:: CSV, скрипт
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Confirm

Запрашивает подтверждение перед запуском командлета.

Тип :: SwitchParameter
Псевдонимы:: cf
Позиция:: Именованный
Значение по умолчанию:: False
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Description

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

Тип :: String
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Force

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

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

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

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

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-LiteralPath

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

Тип :: String
Псевдонимы:: PSPath, LP
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: True
Принимайте подстановочные знаки:: False

-Name

Указывает имена как массив экспортируемых псевдонимов. Подстановочные знаки разрешены.

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

Тип :: String[]
Позиция:: 1
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: True
Принимайте подстановочные знаки:: True

-NoClobber

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

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

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

Тип :: SwitchParameter
Псевдонимы:: NoOverwrite
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-PassThru

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

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Path

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

Тип :: String
Позиция:: 0
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: True

-Scope

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

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

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

Тип :: String
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-WhatIf

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

Тип :: SwitchParameter
Псевдонимы:: wi
Позиция:: Именованный
Значение по умолчанию:: False
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

Входы

Нет

Вы не можете передавать объекты в этот командлет.

Выходы

Нет

По умолчанию этот командлет не возвращает никаких результатов.

Информация об псевдониме

При использовании параметра PassThru этот командлет возвращает объект AliasInfo, представляющий псевдоним.

Примечания

PowerShell включает следующие псевдонимы для Export-Alias:

Все платформы:

Вы можете экспортировать псевдонимы только в файл.