Export-Alias
Экспортирует сведения о определенных в данный момент псевдонимах в файл.
Синтаксис
ByPath (по умолчанию)
Export-Alias
[-Path] <String>
[[-Name] <String[]>]
[-PassThru]
[-As <ExportAliasFormat>]
[-Append]
[-Force]
[-NoClobber]
[-Description <String>]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByLiteralPath
Export-Alias
[[-Name] <String[]>]
-LiteralPath <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.
Команда использует параметр описания
Команда также использует параметр 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 |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-As
Указывает выходной формат. CSV— это значение по умолчанию. Допустимые значения для этого параметра:
- CSV. Формат разделенных запятыми значений (CSV).
- Сценарий. Создает команду
Set-Aliasдля каждого экспортированного псевдонима. Если вы назовете выходной файл с расширением имени файла.ps1, его можно запустить как скрипт, чтобы добавить псевдонимы в любой сеанс.
Свойства параметра
| Тип: | ExportAliasFormat |
| Default value: | None |
| Допустимые значения: | Csv, Script |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Confirm
Запрашивает подтверждение перед запуском cmdlet.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | cf |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Description
Указывает описание экспортированного файла. Описание отображается как комментарий в верхней части файла, следуя сведениям о заголовке.
Свойства параметра
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Force
Принудительно выполняется команда без запроса подтверждения пользователя.
Перезаписывает выходной файл, даже если атрибут только для чтения установлен в файле.
По умолчанию Export-Alias перезаписывает файлы без предупреждения, если в команде не задан только для чтения или скрытый атрибут, или параметр NoClobber используется в команде. Параметр NoClobber имеет приоритет над параметром Force, если оба используются в команде.
Параметр force
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LiteralPath
Указывает путь к выходному файлу. В отличие от пути , значение параметра LiteralPath используется в точности так, как введено. Никакие символы не интерпретируются как подстановочные знаки. Если путь содержит escape-символы, заключите его в одинарные кавычки. Одинарные кавычки указывают PowerShell на то, что не следует интерпретировать какие-либо символы как управляющие последовательности.
Свойства параметра
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | PSPath, LP |
Наборы параметров
ByLiteralPath
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-Name
Задает имена в виде массива псевдонимов для экспорта. Подстановочные символы разрешены.
По умолчанию Export-Alias экспортирует все псевдонимы в сеансе или области.
Свойства параметра
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | True |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 1 |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-NoClobber
Указывает, что этот командлет не позволяет
Если параметр NoClobber опущен, Export-Alias перезаписывает существующий файл без предупреждения, если в файле не задан атрибут только для чтения.
NoClobber имеет приоритет над параметром Force, который позволяет Export-Alias перезаписать файл с атрибутом только для чтения.
NoClobber не препятствует добавлению содержимого в существующий файл параметру добавления.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | NoOverwrite |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-PassThru
Возвращает объект, представляющий элемент, с которым вы работаете. По умолчанию этот командлет не создает выходные данные.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Path
Указывает путь к выходному файлу. Подстановочные знаки разрешены, но итоговое значение пути должно разрешаться в одно имя файла.
Свойства параметра
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | True |
| DontShow: | False |
Наборы параметров
ByPath
| Position: | 0 |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Scope
Указывает область, из которой следует экспортировать псевдонимы. Допустимые значения для этого параметра:
GlobalLocalScript- Число относительно текущей области (от 0 до количества областей, где 0 является текущей областью, а 1 — родительским).
Значение по умолчанию — Local. Для получения дополнительной информации см. about_Scopes.
Свойства параметра
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-WhatIf
Показывает, что произойдет, если командлет будет запущен. Командлет не запускается.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | wi |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.
Входные данные
None
Невозможно передать объекты в этот командлет.
Выходные данные
None
По умолчанию этот командлет не возвращает выходные данные.
AliasInfo
При использовании параметра PassThru этот командлет возвращает объект AliasInfo, представляющий псевдоним.
Примечания
PowerShell включает следующие псевдонимы для Export-Alias:
- Все платформы:
epal
- Вы можете Export-Aliases только в файл.
