New-Alias
Создает новый псевдоним.
Синтаксис
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. Create псевдоним для командлета
New-Alias -Name "List" Get-ChildItem
Эта команда создает псевдоним List для представления командлета Get-ChildItem.
Пример 2. Create псевдоним только для чтения для командлета
New-Alias -Name "C" -Value Get-ChildItem -Description "quick gci alias" -Option ReadOnly
Get-Alias -Name "C" | Format-List *
Эта команда создает псевдоним с именем C
для представления командлета Get-ChildItem
. Он создает описание quick gci alias
для псевдонима и делает его доступным только для чтения. Последняя строка команды использует Get-Alias
для получения нового псевдонима и передает его в Format-List для отображения всех сведений о нем.
Параметры
-Confirm
Запрос подтверждения перед выполнением командлета.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Указывает описание псевдонима. Можно ввести любую строку. Если описание содержит пробелы, заключите его в кавычки.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Указывает, что командлет действует аналогично Set-Alias
, если псевдоним с именем уже существует.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Указывает новый псевдоним. В псевдониме можно использовать любые буквы или цифры, но первым знаком не может быть цифра.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Option
Задает значение свойства Options псевдонима. Допустимые значения:
None
: псевдоним не имеет ограничений (значение по умолчанию)ReadOnly
: псевдоним можно удалить, но изменить его можно только с помощью параметра Force .Constant
: псевдоним не может быть удален или изменен.Private
: псевдоним доступен только в текущем областьAllScope
: псевдоним копируется во все новые области, которые создаются.Unspecified
: параметр не указан.
Эти значения определяются как перечисление на основе флагов. С помощью этого параметра можно объединить несколько значений, чтобы задать несколько флагов. Значения могут передаваться в параметр Option в виде массива значений или в виде строки этих значений, разделенной запятыми. Командлет объединит значения с помощью операции binary-OR. Передача значений в виде массива является самым простым вариантом, а также позволяет использовать для значений заполнение табуляции.
Чтобы просмотреть свойство Options всех псевдонимов в сеансе, введите Get-Alias | Format-Table -Property Name, Options -AutoSize
.
Type: | ScopedItemOptions |
Accepted values: | None, ReadOnly, Constant, Private, AllScope, Unspecified |
Position: | Named |
Default value: | [System.Management.Automation.ScopedItemOptions]::None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Возвращает объект, представляющий элемент, с которым вы работаете. По умолчанию этот командлет не создает выходные данные.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Scope
Указывает область действия нового псевдонима. Допустимые значения для этого параметра:
Global
Local
Script
- Число относительно текущего область (от 0 до количества областей, где
0
— текущий область, а1
— родительский).
Значение по умолчанию — Local
. Дополнительные сведения см. в разделе about_Scopes.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Value
Указывает имя командлета или элемента команды, для которого создается псевдоним.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Показывает, что произойдет при запуске командлета. Командлет не выполняется.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Входные данные
None
Вы не можете передавать объекты в этот командлет.
Выходные данные
None
По умолчанию этот командлет не возвращает выходные данные.
При использовании параметра PassThru этот командлет возвращает объект AliasInfo , представляющий новый псевдоним.
Примечания
PowerShell включает следующие псевдонимы для New-Alias
:
Для всех платформ.
nal
Чтобы создать новый псевдоним, используйте
Set-Alias
илиNew-Alias
. Чтобы изменить псевдоним, используйте .Set-Alias
Чтобы удалить псевдоним, используйте .Remove-Alias