Aliasy parametrówParameter Aliases

Parametry polecenia cmdlet mogą również mieć aliasy.Cmdlet parameters can also have aliases. Aliasów można używać zamiast nazw parametrów podczas wpisywania lub określania parametru w poleceniu.You can use the aliases instead of the parameter names when you type or specify the parameter in a command.

Zalety korzystania z aliasówBenefits of Using Aliases

Dodanie aliasów do parametrów zapewnia następujące korzyści.Adding aliases to parameters provides the following benefits.

  • Możesz podać skrót, aby użytkownik nie musiał używać pełnej nazwy parametru, gdy zostanie wywołane polecenie cmdlet.You can provide a shortcut so that the user does not have to use the complete parameter name when the cmdlet is called. Można na przykład użyć aliasu "CN" zamiast nazwy parametru "ComputerName".For example, you could use the "CN" alias instead of the parameter name "ComputerName".

  • Można zdefiniować wiele aliasów, jeśli chcesz podać różne nazwy dla tego samego parametru.You can define multiple aliases if you want to provide different names for the same parameter. Może być konieczne zdefiniowanie wielu aliasów, jeśli trzeba będzie współpracować z wieloma grupami użytkowników, które odwołują się do tych samych danych na różne sposoby.You might want to define multiple aliases if you have to work with multiple user groups that refer to the same data in different ways.

  • Istnieje możliwość zapewnienia zgodności z poprzednimi wersjami dla istniejących skryptów w przypadku zmiany nazwy parametru.You can provide backwards compatibility for existing scripts if the name of a parameter changes.

  • Używając atrybutu aliasu wraz z atrybutem ValueFromPipelineByName, można zdefiniować parametr, który umożliwia powiązanie polecenia cmdlet z różnymi typami obiektów.By using the Alias attribute along with the ValueFromPipelineByName attribute, you can define a parameter that allows your cmdlet to bind to different object types. Załóżmy na przykład, że istniały dwa obiekty różnych typów, a pierwszy obiekt miał właściwość składnika zapisywania, a drugi obiekt miał Właściwość edytora.For example, say you had two objects of different types and the first object had a writer property and the second object had an editor property. Jeśli polecenie cmdlet miało parametr z aliasami składnika zapisywania i edytora, a polecenie cmdlet zaakceptował dane wejściowe potoku na podstawie nazw właściwości, polecenie cmdlet może powiązać się z obydwoma obiektami przy użyciu dwóch aliasów parametrów.If your cmdlet had a parameter that had writer and editor aliases and the cmdlet accepted pipeline input based in property names, your cmdlet could bind to both objects using the two parameter aliases.

Aby uzyskać więcej informacji na temat aliasów, które mogą być używane z określonymi parametrami, zobacz typowe nazwy parametrów.For more information about aliases that can be used with specific parameters, see Common Parameter Names.

Definiowanie aliasów parametrówDefining Parameter Aliases

Aby zdefiniować alias dla parametru, zadeklaruj atrybut aliasu, jak pokazano w następującej deklaracji parametru.To define an alias for a parameter, declare the Alias attribute, as shown in the following parameter declaration. W tym przykładzie zdefiniowano wiele aliasów dla tego samego parametru.In this example, multiple aliases are defined for the same parameter. (Aby uzyskać więcej informacji, zobaczHow to DECLARE Parameters cmdlet.)(For more information, seeHow to Declare Cmdlet Parameters.)

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

Zobacz teżSee Also

Typowe nazwy parametrówCommon Parameter Names

Jak zadeklarować parametry polecenia cmdletHow to Declare Cmdlet Parameters

Pisanie polecenia cmdlet programu Windows PowerShellWriting a Windows PowerShell Cmdlet