ActivityParameter interface
活动参数的定义。
属性
| description | 获取或设置活动参数的说明。 |
| is |
获取或设置一个布尔值,该值指示参数是否为动态。 |
| is |
获取或设置一个布尔值,该值指示如果参数是必需的,则为 true。 如果值为 false,则参数是可选的。 |
| name | 获取或设置活动参数的名称。 |
| position | 获取或设置活动参数的位置。 |
| type | 获取或设置活动参数的类型。 |
| validation |
获取或设置活动参数的验证集。 |
| value |
获取或设置一个布尔值,该值指示参数是否可以从传入管道对象获取值时为 true。 如果 cmdlet 必须访问完整的输入对象,则使用此设置。 false 表示参数无法从完整的输入对象获取值。 |
| value |
获取或设置一个布尔值,该值指示是否可以从与此参数同名的传入管道对象的属性填充该参数。 false 表示无法从具有相同名称的传入管道对象属性填充参数。 |
| value |
获取或设置一个布尔值,该值指示如果 cmdlet 参数接受以数组形式与此参数关联的所有剩余命令行参数,则该值指示 true。 如果 cmdlet 参数不接受所有剩余参数值,则为 false。 |
属性详细信息
description
获取或设置活动参数的说明。
description?: string
属性值
string
isDynamic
获取或设置一个布尔值,该值指示参数是否为动态。
isDynamic?: boolean
属性值
boolean
isMandatory
获取或设置一个布尔值,该值指示如果参数是必需的,则为 true。 如果值为 false,则参数是可选的。
isMandatory?: boolean
属性值
boolean
name
获取或设置活动参数的名称。
name?: string
属性值
string
position
获取或设置活动参数的位置。
position?: number
属性值
number
type
获取或设置活动参数的类型。
type?: string
属性值
string
validationSet
获取或设置活动参数的验证集。
validationSet?: ActivityParameterValidationSet[]
属性值
valueFromPipeline
获取或设置一个布尔值,该值指示参数是否可以从传入管道对象获取值时为 true。 如果 cmdlet 必须访问完整的输入对象,则使用此设置。 false 表示参数无法从完整的输入对象获取值。
valueFromPipeline?: boolean
属性值
boolean
valueFromPipelineByPropertyName
获取或设置一个布尔值,该值指示是否可以从与此参数同名的传入管道对象的属性填充该参数。 false 表示无法从具有相同名称的传入管道对象属性填充参数。
valueFromPipelineByPropertyName?: boolean
属性值
boolean
valueFromRemainingArguments
获取或设置一个布尔值,该值指示如果 cmdlet 参数接受以数组形式与此参数关联的所有剩余命令行参数,则该值指示 true。 如果 cmdlet 参数不接受所有剩余参数值,则为 false。
valueFromRemainingArguments?: boolean
属性值
boolean