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
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-As

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

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

Тип:	ExportAliasFormat
Допустимые значения:	Csv, Script
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Confirm

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

Тип:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Description

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

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Force

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

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

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

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

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-LiteralPath

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

Тип:	String
Aliases:	PSPath, LP
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Name

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

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

Тип:	String[]
Position:	1
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	True

-NoClobber

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

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

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

Тип:	SwitchParameter
Aliases:	NoOverwrite
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-PassThru

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

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Path

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

Тип:	String
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	True

-Scope

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

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

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

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-WhatIf

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

Тип:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

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

None

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

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

None

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

AliasInfo

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

Примечания

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

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

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

Поделиться через

Export-Alias

Синтаксис

Описание

Примеры

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

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

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

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

Параметры

-Append

-As

-Confirm

-Description

-Force

-LiteralPath

-Name

-NoClobber

-PassThru

-Path

-Scope

-WhatIf

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

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

Примечания

Дополнительные ресурсы

Поделиться через

Export-Alias

Синтаксис

Описание

Примеры

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

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

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

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

Параметры

-Append

-As

-Confirm

-Description

-Force

-LiteralPath

-Name

-NoClobber

-PassThru

-Path

-Scope

-WhatIf

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

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

Примечания

Связанные ссылки

Дополнительные ресурсы