ScriptParameter interface
An parameter that the script will accept
Properties
| description | User friendly description of the parameter NOTE: This property will not be serialized. It can only be populated by the server. |
| name | The parameter name that the script will expect a parameter value for |
| optional | Is this parameter required or optional NOTE: This property will not be serialized. It can only be populated by the server. |
| type | The type of parameter the script is expecting. psCredential is a PSCredentialObject NOTE: This property will not be serialized. It can only be populated by the server. |
| visibility | Should this parameter be visible to arm and passed in the parameters argument when executing NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
description
User friendly description of the parameter NOTE: This property will not be serialized. It can only be populated by the server.
description?: stringProperty Value
string
name
The parameter name that the script will expect a parameter value for
name?: stringProperty Value
string
optional
Is this parameter required or optional NOTE: This property will not be serialized. It can only be populated by the server.
optional?: stringProperty Value
string
type
The type of parameter the script is expecting. psCredential is a PSCredentialObject NOTE: This property will not be serialized. It can only be populated by the server.
type?: stringProperty Value
string
visibility
Should this parameter be visible to arm and passed in the parameters argument when executing NOTE: This property will not be serialized. It can only be populated by the server.
visibility?: stringProperty Value
string