ActivityParameter interface

Package:

@azure/arm-automation

Definition of the activity parameter.

Properties

description	Gets or sets the description of the activity parameter.
isDynamic	Gets or sets a Boolean value that indicates true if the parameter is dynamic.
isMandatory	Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional.
name	Gets or sets the name of the activity parameter.
position	Gets or sets the position of the activity parameter.
type	Gets or sets the type of the activity parameter.
validationSet	Gets or sets the validation set of activity parameter.
valueFromPipeline	Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object.
valueFromPipelineByPropertyName	Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name.
valueFromRemainingArguments	Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values.

Property Details

description

Gets or sets the description of the activity parameter.

description?: string

Property Value

string

isDynamic

Gets or sets a Boolean value that indicates true if the parameter is dynamic.

isDynamic?: boolean

Property Value

boolean

isMandatory

Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional.

isMandatory?: boolean

Property Value

boolean

name

Gets or sets the name of the activity parameter.

name?: string

Property Value

string

position

Gets or sets the position of the activity parameter.

position?: number

Property Value

number

type

Gets or sets the type of the activity parameter.

type?: string

Property Value

string

validationSet

Gets or sets the validation set of activity parameter.

validationSet?: ActivityParameterValidationSet[]

Property Value

ActivityParameterValidationSet[]

valueFromPipeline

Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object.

valueFromPipeline?: boolean

Property Value

boolean

valueFromPipelineByPropertyName

Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name.

valueFromPipelineByPropertyName?: boolean

Property Value

boolean

valueFromRemainingArguments

Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values.

valueFromRemainingArguments?: boolean

Property Value

boolean