Feedback Edit

ScriptParameter Class

  • Reference

An parameter that the script will accept.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
Model
ScriptParameter

Constructor

ScriptParameter(*, name: Optional[str] = None, **kwargs)

Parameters

name
str
Required

The parameter name that the script will expect a parameter value for.

Variables

type
str or ScriptParameterTypes

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

description
str

User friendly description of the parameter.

visibility
str or VisibilityParameterEnum

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

optional
str or OptionalParamEnum

Is this parameter required or optional. Possible values include: "Optional", "Required".