ParaméteraliasokParameter Aliases

A parancsmag paraméterei álneveket is tartalmazhatnak.Cmdlet parameters can also have aliases. A paraméter neve helyett használhatja az aliasokat, amikor beírja vagy megadja a paramétert egy parancsban.You can use the aliases instead of the parameter names when you type or specify the parameter in a command.

Az aliasok használatának előnyeiBenefits of Using Aliases

Az aliasok paraméterekhez való hozzáadása a következő előnyöket biztosítja.Adding aliases to parameters provides the following benefits.

  • Megadhat egy parancsikont, amellyel a felhasználónak nem kell a teljes paraméter nevét használnia a parancsmag meghívásakor.You can provide a shortcut so that the user does not have to use the complete parameter name when the cmdlet is called. Például a "számítógépnév" nevű paraméter helyett a "CN" aliast használhatja.For example, you could use the "CN" alias instead of the parameter name "ComputerName".

  • Több aliast is megadhat, ha más neveket kíván megadni ugyanahhoz a paraméterhez.You can define multiple aliases if you want to provide different names for the same parameter. Előfordulhat, hogy több aliast is meg kell határoznia, ha több olyan felhasználói csoporttal szeretne dolgozni, amelyek különböző módokon hivatkoznak ugyanarra az adattípusra.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.

  • A meglévő parancsfájlok visszamenőleges kompatibilitását is megadhatja, ha a paraméter neve megváltozik.You can provide backwards compatibility for existing scripts if the name of a parameter changes.

  • Ha az alias attribútumot a ValueFromPipelineByName attribútummal együtt használja, megadhat egy olyan paramétert, amely lehetővé teszi, hogy a parancsmag különböző objektumtípusokhoz kapcsolódjon.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. Tegyük fel például, hogy két különböző típusú objektuma volt, és az első objektumnak van egy író tulajdonsága, és a második objektum szerkesztő tulajdonsága volt.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. Ha a parancsmag olyan paraméterrel rendelkezett, amely rendelkezik író és szerkesztő aliasokkal, a parancsmag pedig a tulajdonságok nevei alapján fogadta el a folyamat bemenetét, a parancsmag mindkét objektumhoz köthető a két paraméter alias használatával.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.

Az adott paraméterekkel használható aliasokkal kapcsolatos további információkért lásd: köznapi paraméterek nevei.For more information about aliases that can be used with specific parameters, see Common Parameter Names.

Paraméter-aliasok definiálásaDefining Parameter Aliases

Egy paraméter aliasának megadásához állapítsa meg az alias attribútumot, ahogy az a következő paraméter deklarációjában látható.To define an alias for a parameter, declare the Alias attribute, as shown in the following parameter declaration. Ebben a példában több alias van definiálva ugyanahhoz a paraméterhez.In this example, multiple aliases are defined for the same parameter. (További információ:a parancsmag paramétereinek deklarálása.)(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;

Lásd még:See Also

Gyakori paraméternevekCommon Parameter Names

Parancsmag-paraméterek deklarálásaHow to Declare Cmdlet Parameters

Windows PowerShell-parancsmag írásaWriting a Windows PowerShell Cmdlet