パラメーターとしてプロパティを宣言する

  • [アーティクル]

このトピックでは、コマンドレットのパラメーターを宣言する前に理解しておく必要がある基本的な情報について説明します。

コマンドレットクラス内のコマンドレットのパラメーターを宣言するには、各パラメーターを表すパブリックプロパティを定義し、1つまたは複数のパラメーター属性を各プロパティに追加します。 Windows PowerShell ランタイムは、パラメーター属性を使用して、コマンドレットパラメーターとしてプロパティを識別します。 パラメーター属性を宣言するための基本構文は [Parameter()] です。

必須パラメーターとして定義されたプロパティの例を次に示します。

[Parameter(Position = 0, Mandatory = true)]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;

ここでは、パラメーターについて覚えておくべきことをいくつか紹介します。

  • パラメーターは、明示的にパブリックとしてマークする必要があります。 パブリックに既定値としてマークされていないパラメーターは、Windows PowerShell ランタイムによって検出されません。

  • パラメーターの検証を強化するには、パラメーターを Microsoft .NET Framework 型として定義する必要があります。 たとえば、値のセットから1つの値に制限されているパラメーターは、列挙型として定義する必要があります。 Uniform Resource Identifier (URI) 値を受け取るパラメーターは、system.string 型にする必要があります。

  • 自由形式のテキストプロパティ以外のすべてに対して、基本的な文字列パラメーターを使用しないようにします。

  • 任意の数のパラメーターセットにパラメーターを追加できます。 パラメーターセットの詳細については、「 コマンドレットパラメーターセット」を参照してください。

Windows PowerShell には、すべてのコマンドレットで自動的に使用できる一連の共通パラメーターも用意されています。 これらのパラメーターとそのエイリアスの詳細については、「 コマンドレットの共通パラメーター」を参照してください。

参照

コマンドレットの共通パラメーター

コマンドレットパラメーターの型

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