参数别名

Cmdlet 参数还可以具有别名。 在命令中键入或指定参数时,可以使用别名而不是参数名称。

使用别名的好处

将别名添加到参数具有以下优势。

  • 可以提供快捷方式,以便用户无需在调用 cmdlet 时使用完整的参数名称。 例如,可以使用"CN"别名而不是参数名称"ComputerName"。

  • 如果要为同一参数提供不同的名称,可以定义多个别名。 如果必须处理以不同方式引用相同数据的多个用户组,可能需要定义多个别名。

  • 如果参数名称发生更改,可以为现有脚本提供向后兼容性。

  • 通过使用 Alias 属性和 ValueFromPipelineByName 属性,可以定义允许 cmdlet 绑定到不同对象类型的参数。 例如,假设你有两个不同类型的对象,第一个对象具有编写器属性,第二个对象具有编辑器属性。 如果 cmdlet 具有具有编写器别名和编辑器别名的参数,并且 cmdlet 接受基于属性名称的管道输入,则 cmdlet 可以通过这两个参数别名绑定到这两个对象。

有关可与特定参数一起使用的别名详细信息,请参阅 通用参数名称

定义参数别名

若要定义参数的别名,请声明 Alias 属性,如以下参数声明所示。 本示例为同一参数定义了多个别名。 (有关详细信息,请参阅如何声明 Cmdlet参数 .)

[Alias("UN","Writer","Editor")]
[Parameter()]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;

另请参阅

常见参数名称

如何声明 Cmdlet 参数

编写 Windows PowerShell Cmdlet