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

これらの例では、名前付きパラメーター、位置指定パラメーター、必須パラメーター、省略可能パラメーター、およびスイッチ パラメーターを宣言する方法を示します。 これらの例では、パラメーターの別名を定義する方法も示します。

名前付きパラメーターを宣言する方法

• 次のコードに示すように、パブリック プロパティを定義します。 Parameter 属性を追加するときに、 属性から Position キーワードを省略します。

  [Parameter()]
  public string UserName
  {
    get { return userName; }
    set { userName = value; }
  }
  private string userName;
  

Parameter 属性の詳細については、「パラメーター属性宣言」 を参照してください。

位置指定パラメーターを宣言する方法

• 次のコードに示すように、パブリック プロパティを定義します。 Parameter 属性を追加するときに、 キーワードを Position 引数の位置に設定します。 値 0 は、最初の位置を示します。

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

Parameter 属性の詳細については、「パラメーター属性宣言」 を参照してください。

必須パラメーターを宣言する方法

• 次のコードに示すように、パブリック プロパティを定義します。 Parameter 属性を追加するときに、 キーワードを に Mandatory 設定します true 。

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

Parameter 属性の詳細については、「パラメーター属性宣言」 を参照してください。

省略可能なパラメーターを宣言する方法

• 次のコードに示すように、パブリック プロパティを定義します。 Parameter 属性を追加するときに、 キーワードを省略 Mandatory します。

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

Switch パラメーターを宣言する方法

• パブリック プロパティを System.Management.Automation.SwitchParameter型として定義し、Parameter 属性を宣言します。

  [Parameter(Position = 1)]
  public SwitchParameter GoodBye
  {
    get { return goodbye; }
    set { goodbye = value; }
  }
  private bool goodbye;
  

Parameter 属性の詳細については、「パラメーター属性宣言」 を参照してください。

エイリアスを使用してパラメーターを宣言する方法

• 次のコードに示すように、パブリック プロパティを定義します。 パラメーターのエイリアスを一覧表示する Alias 属性を追加します。 この例では、同じパラメーターに対して 3 つのエイリアスが定義されています。 最初のエイリアスはショートカットを提供します。 2 番目と 3 番目のエイリアスは、さまざまなシナリオで使用できる名前を提供します。

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

Alias 属性の詳細については、「別名属性宣言」 を参照してください。

参照

System.Management.Automation.SwitchParameter

パラメーター属性の宣言

エイリアス属性の宣言

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