Share via


ScriptParameter Class

Definition

An parameter that the script will accept

public class ScriptParameter
type ScriptParameter = class
Public Class ScriptParameter
Inheritance
ScriptParameter

Constructors

ScriptParameter()

Initializes a new instance of the ScriptParameter class.

ScriptParameter(String, String, String, String, String)

Initializes a new instance of the ScriptParameter class.

Properties

Description

Gets user friendly description of the parameter

Name

Gets or sets the parameter name that the script will expect a parameter value for

Optional

Gets is this parameter required or optional. Possible values include: 'Optional', 'Required'

Type

Gets the type of parameter the script is expecting. psCredential is a PSCredentialObject. Possible values include: 'String', 'SecureString', 'Credential', 'Int', 'Bool', 'Float'

Visibility

Gets should this parameter be visible to arm and passed in the parameters argument when executing. Possible values include: 'Visible', 'Hidden'

Applies to