EnvironmentDefinitionParameterOutput interface

Properties of an Environment Definition parameter

Properties

allowed

An array of allowed values.

default

Default value of the parameter.

description

Description of the parameter.

id

Unique ID of the parameter.

name

Display name of the parameter.

readOnly

Whether or not this parameter is read-only. If true, default should have a value.

required

Whether or not this parameter is required.

type

A string of one of the basic JSON types (number, integer, array, object, boolean, string).

Property Details

allowed

An array of allowed values.

allowed?: string[]

Property Value

string[]

default

Default value of the parameter.

default?: string

Property Value

string

description

Description of the parameter.

description?: string

Property Value

string

id

Unique ID of the parameter.

id: string

Property Value

string

name

Display name of the parameter.

name?: string

Property Value

string

readOnly

Whether or not this parameter is read-only. If true, default should have a value.

readOnly?: boolean

Property Value

boolean

required

Whether or not this parameter is required.

required: boolean

Property Value

boolean

type

A string of one of the basic JSON types (number, integer, array, object, boolean, string).

type: string

Property Value

string