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

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.

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

Команда также использует параметр 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:False
Обязательно: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 не может принудительно перезаписать файлы с помощью скрытого атрибута.

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

-LiteralPath

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

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

-Name

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

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

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

-NoClobber

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

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

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

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

-PassThru

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

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

-Path

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

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

-Scope

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

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

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

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

-WhatIf

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

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

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

None.

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

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

None or System.Management.Automation.AliasInfo

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

Примечания

  • Вы можете Export-Aliases только в файл.