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

Синтаксис

Export-Alias [-Path] <string> [[-Name] <string[]>] [-Append] [-As {<Csv> | <Script>}] [-Описание <string>] [-Force] [-NoClobber] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]

Описание

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

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

Параметры

-Append

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

Обязательно?

false

Позиция?

named

Значение по умолчанию

Принимать входные данные из конвейера?

false

Принимать подстановочные знаки?

false

-As <ExportAliasFormat>

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

Допустимые значения:

-- CSV: формат значений, разделенных запятыми (CSV);

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

Обязательно?

false

Позиция?

named

Значение по умолчанию

Принимать входные данные из конвейера?

false

Принимать подстановочные знаки?

false

-Описание <string>

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

Обязательно?

false

Позиция?

named

Значение по умолчанию

Принимать входные данные из конвейера?

false

Принимать подстановочные знаки?

false

-Force

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

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

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

Обязательно?

false

Позиция?

named

Значение по умолчанию

Does not overwrite read-only files.

Принимать входные данные из конвейера?

false

Принимать подстановочные знаки?

false

-Name <string[]>

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

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

Обязательно?

false

Позиция?

2

Значение по умолчанию

Export all aliases

Принимать входные данные из конвейера?

true (ByPropertyName)

Принимать подстановочные знаки?

false

-NoClobber

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

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

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

Обязательно?

false

Позиция?

named

Значение по умолчанию

Overwrites read-write files.

Принимать входные данные из конвейера?

false

Принимать подстановочные знаки?

false

-PassThru

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

Обязательно?

false

Позиция?

named

Значение по умолчанию

No output

Принимать входные данные из конвейера?

false

Принимать подстановочные знаки?

false

-Path <string>

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

Обязательно?

true

Позиция?

1

Значение по умолчанию

нет

Принимать входные данные из конвейера?

false

Принимать подстановочные знаки?

false

-Scope <string>

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

Допустимые значения: "Global", "Local", "Script" или число относительно текущей области (от 0 до количества областей, где 0 — текущая область, а 1 — ее родительская область). По умолчанию используется значение "Local". Дополнительные сведения см. в разделе about_Scopes.

Обязательно?

false

Позиция?

named

Значение по умолчанию

Local

Принимать входные данные из конвейера?

false

Принимать подстановочные знаки?

false

-Confirm

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

Обязательно?

false

Позиция?

named

Значение по умолчанию

Принимать входные данные из конвейера?

false

Принимать подстановочные знаки?

false

-WhatIf

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

Обязательно?

false

Позиция?

named

Значение по умолчанию

Принимать входные данные из конвейера?

false

Принимать подстановочные знаки?

false

<CommonParameters>

Данный командлет поддерживает общие параметры -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer и -OutVariable. Дополнительные сведения см. в разделе about_Commonparameters.

Ввод и вывод

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

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

Нет.

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

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

Нет или System.Management.Automation.AliasInfo

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

Примечания

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

Пример 1

C:\PS>export-alias -path alias.csv

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






Пример 2

C:\PS>export-alias -path alias.csv -noclobber

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

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






Пример 3

C:\PS>export-alias -path alias.csv -append -description "Appended Aliases" -force

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

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

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






Пример 4

C:\PS>export-alias -path alias.ps1 -as script

C:\PS> add-content -path $profile -value (get-content alias.ps1)

C:\PS> $s = new-pssession -computername Server01
C:\PS> 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 в новом сеансе.






См. также




Содержание