ParameterDefinitionsValue Class

The definition of a parameter that can be provided to the policy.

Constructor

ParameterDefinitionsValue()

Variables

Name	Description
type	Union[str, <xref:"ParameterType">] The data type of the parameter. Known values are: "String", "Array", "Object", "Boolean", "Integer", "Float", and "DateTime".
allowedValues	list[Any] The allowed values for the parameter.
defaultValue	Any The default value for the parameter if no value is provided.
schema	Any Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
metadata	<xref:<xref:"ParameterDefinitionsValueMetadata">> General metadata for the parameter.

Attributes

allowedValues

The allowed values for the parameter.

allowedValues: list[Any]

defaultValue

The default value for the parameter if no value is provided.

defaultValue: Any

metadata

General metadata for the parameter.

metadata: ParameterDefinitionsValueMetadata

schema

Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.

schema: Any

type

"String", "Array", "Object", "Boolean", "Integer", "Float", and "DateTime".

type: str | ParameterType