パラメーターのエイリアス

  • [アーティクル]

コマンドレット パラメーターには別名を指定することもできます。 コマンドでパラメーターを入力または指定するときに、パラメーター名の代わりにエイリアスを使用できます。

エイリアスを使用する利点

パラメーターにエイリアスを追加すると、次の利点があります。

  • ショートカットを指定して、コマンドレットの呼び出し時にユーザーが完全なパラメーター名を使用する必要が生じなくすることができます。 たとえば、パラメーター名 "ComputerName" の代わりに "CN" エイリアスを使用できます。

  • 同じパラメーターに異なる名前を指定する場合は、複数の別名を定義できます。 同じデータをさまざまな方法で参照する複数のユーザー グループを使用する必要がある場合は、複数のエイリアスを定義できます。

  • パラメーターの名前が変更された場合は、既存のスクリプトの下位互換性を提供できます。

  • Alias 属性を ValueFromPipelineByName 属性と共に使用することで、コマンドレットが異なるオブジェクトの種類にバインドできるパラメーターを定義できます。 たとえば、型が異なる 2 つのオブジェクトを持ち、1 つ目のオブジェクトにライター プロパティが含み、2 番目のオブジェクトにエディター プロパティがあったとします。 コマンドレットにライターとエディターのエイリアスを含むパラメーターが含まれています。また、コマンドレットがプロパティ名に基づくパイプライン入力を受け入れる場合、コマンドレットは 2 つのパラメーターエイリアスを使用して両方のオブジェクトにバインドできます。

特定のパラメーターで使用できるエイリアスの詳細については、「共通パラメーター名」 を参照してください。

パラメーターエイリアスの定義

パラメーターのエイリアスを定義するには、次のパラメーター宣言に示すように、Alias 属性を宣言します。 この例では、同じパラメーターに対して複数のエイリアスが定義されています。 (詳細については、「コマンドレット パラメーターを宣言する方法」を参照してください)。

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

参照

共有パラメーター名

コマンドレット パラメーターを宣言する方法

Windows PowerShell コマンドレットの記述