参数属性声明

Parameter 属性将 cmdlet 类的公共属性标识为 cmdlet 参数。

句法

[Parameter()]
[Parameter(Named Parameters...)]

参数

强制 (System.Boolean) 可选命名参数。 True 表示 cmdlet 参数是必需的。如果调用 cmdlet 时未提供必需的参数，Windows PowerShell 会提示用户输入参数值。默认值为false。

ParameterSetName (System.String) 可选的命名参数。指定此 cmdlet 参数所属的参数集。如果不指定参数集，则该参数属于所有参数集。

Position (System.Int32) 可选命名参数。指定参数在 Windows PowerShell 命令中的位置。

ValueFromPipeline (System.Boolean) 可选命名参数。 True 表示 cmdlet 参数从管道对象获取其值。如果 cmdlet 访问完整的对象，而不仅仅是对象的属性，请指定此关键字。默认值为false。

ValueFromPipelineByPropertyName (System.Boolean) 可选命名参数。 True 表示 cmdlet 参数从与此参数具有相同名称或相同别名的管道对象的属性中获取其值。例如，如果 cmdlet 具有 Name 参数，并且管道对象也具有 Name 属性，则 Name 属性的值将分配给cmdlet 的 Name 参数。默认值为false。

ValueFromRemainingArguments (System.Boolean) 可选命名参数。 True 表示 cmdlet 参数接受传递给 cmdlet 的所有剩余参数。默认值为false。

HelpMessage 可选的命名参数。指定参数的简短描述。当运行 cmdlet 且未指定强制参数时，Windows PowerShell 会显示此消息。

HelpMessageBaseName 可选的命名参数。指定资源标识符所在的位置。例如，此参数可以指定包含要本地化的帮助消息的资源程序集。

HelpMessageResourceId 可选命名参数。指定帮助消息的资源标识符。

评论

• 有关如何声明此属性的详细信息，请参阅如何声明 Cmdlet 参数。

• cmdlet 可以具有任意数量的参数。但是，为了获得更好的用户体验，请限制参数数量。

• 参数必须在公共非静态字段或属性上声明。参数应该在属性上声明。该属性必须具有公共 set 访问器，并且如果指定了 ValueFromPipeline 或 ValueFromPipelineByPropertyName 关键字，则该属性必须具有公共 get 访问器。

• 指定位置参数时，请将参数集中的位置参数数量限制为少于 5 个。并且，位置参数不必是连续的。位置 5、100 和 250 的工作方式与位置 0、1 和 2 相同。

• 当未指定 Position 关键字时，必须通过其名称引用 cmdlet 参数。

• 使用参数集时，请注意以下事项：

  • 每个参数集必须至少有一个唯一的参数。良好的 cmdlet 设计表明，如果可能的话，这个唯一参数也应该是强制性的。如果您的 cmdlet 设计为不带参数运行，则唯一参数不能是强制的。

• 任何参数集不应包含多个具有相同位置的位置参数。

• 参数集中只有一个参数应声明 ValueFromPipeline=true。

• 可以定义多个参数 ValueFromPipelineByPropertyName=true。

参见

系统.管理.自动化.参数属性

Cmdlet 参数名称

编写 Windows PowerShell Cmdlet