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

New-Alias

Модуль:
Microsoft.PowerShell.Utility Module

Создает новый псевдоним.

Синтаксис

Default (по умолчанию) 

New-Alias
    [-Name] <String>
    [-Value] <String>
    [-Description <String>]
    [-Option <ScopedItemOptions>]
    [-PassThru]
    [-Scope <String>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Описание

Командлет New-Alias создает новый псевдоним в текущем сеансе PowerShell. Псевдонимы, созданные с помощью New-Alias, не сохраняются после выхода из сеанса или закрытия PowerShell. Вы можете использовать командлет Export-Alias для сохранения сведений о псевдониме в файл. Позже вы можете использовать Import-Alias для получения сведений о сохраненных псевдонимах.

Примеры

Пример 1. Создание псевдонима для командлета

New-Alias -Name "List" Get-ChildItem

Эта команда создает псевдоним с именем List для представления командлета Get-ChildItem.

Пример 2. Создание псевдонима только для чтения для командлета

Эта команда создает псевдоним с именем C для представления командлета Get-ChildItem. Он создает описание "Быстрый псевдоним gci" для псевдонима и делает его доступным только для чтения.

New-Alias -Name "C" -Value Get-ChildItem -Description "Quick gci alias" -Option ReadOnly
Get-Alias -Name "C" | Format-List *

HelpUri             : https://go.microsoft.com/fwlink/?LinkID=2096492
ResolvedCommandName : Get-ChildItem
DisplayName         : C -> Get-ChildItem
ReferencedCommand   : Get-ChildItem
ResolvedCommand     : Get-ChildItem
Definition          : Get-ChildItem
Options             : ReadOnly
Description         : Quick gci alias
OutputType          : {System.IO.FileInfo, System.IO.DirectoryInfo}
Name                : C
CommandType         : Alias
Source              :
Version             :
Visibility          : Public
ModuleName          :
Module              :
RemotingCapability  : PowerShell
Parameters          : {[Path, System.Management.Automation.ParameterMetadata], [LiteralPath,
                      System.Management.Automation.ParameterMetadata], [Filter,
                      System.Management.Automation.ParameterMetadata], [Include,
                      System.Management.Automation.ParameterMetadata]…}

Команда Get-Alias, переданная в Format-List, отображает все сведения о новом псевдониме.

Пример 3. Создание псевдонима для команды с параметрами

function Set-ParentDirectory {Set-Location -Path ..}
New-Alias -Name .. -Value Set-ParentDirectory

Первая команда создает функцию Set-ParentDirectory, которая использует Set-Location для задания расположения в родительском каталоге. Вторая команда использует New-Alias для создания псевдонима .. для вызова функции Set-ParentDirectory. Так как для параметра Value требуется командлет, функция или исполняемое значение, необходимо создать пользовательскую функцию, чтобы создать псевдоним, использующий параметры. Запуск псевдонима .. изменяет текущее расположение в родительском каталоге.

Параметры

-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

Указывает, что командлет действует как Set-Alias, если псевдоним уже существует.

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Name

Задает новый псевдоним. Вы можете использовать любые буквенно-цифровые символы в псевдониме, но первый символ не может быть числом.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:0
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Option

Задает значение свойства Options псевдонима. Допустимые значения:

  • None: псевдоним не имеет ограничений (значение по умолчанию)
  • ReadOnly: псевдоним можно удалить, но изменить его нельзя, за исключением использования параметра Force
  • Constant: псевдоним нельзя удалить или изменить
  • Private: Этот псевдоним доступен только в текущей области
  • AllScope: псевдоним копируется в любые новые области, которые создаются
  • Unspecified: параметр не указан

Эти значения определяются как перечисление, основанное на флагах. Можно объединить несколько значений, чтобы задать несколько флагов с помощью этого параметра. Значения можно передать параметру Option в виде массива значений или в виде строки, разделенной запятыми этих значений. Командлет объединяет значения с помощью операции binary-OR. Передача значений в виде массива является самым простым вариантом, а также позволяет использовать дополнение при нажатии Tab для значений.

Чтобы просмотреть свойство options всех псевдонимов в сеансе, введите Get-Alias | Format-Table -Property Name, Options -AutoSize.

Свойства параметра

Тип:ScopedItemOptions
Default value:[System.Management.Automation.ScopedItemOptions]::None
Допустимые значения:None, ReadOnly, Constant, Private, AllScope, Unspecified
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-PassThru

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

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Scope

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

  • Global
  • Local
  • Script
  • Число относительно текущей области (от 0 до числа областей, где 0 является текущей областью и 1 является ее родительским объектом).

Local — это значение по умолчанию. Для получения дополнительной информации см. about_Scopes.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Value

Указывает имя псевдонима командлета или элемента команды.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:1
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов: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 включает следующие псевдонимы для New-Alias:

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

    • nal

  • Чтобы создать новый псевдоним, используйте Set-Alias или New-Alias. Чтобы изменить псевдоним, используйте Set-Alias. Чтобы удалить псевдоним, используйте Remove-Alias.