ParameterDefinitionsValue Class

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

Constructor

ParameterDefinitionsValue(*args: Any, **kwargs: Any)

Variables

Name Description
type

The data type of the parameter. Known values are: "String", "Array", "Object", "Boolean", "Integer", "Float", and "DateTime".

allowed_values

The allowed values for the parameter.

default_value
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

General metadata for the parameter.

Attributes

allowed_values

The allowed values for the parameter.

allowed_values: list[Any] | None

default_value

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

default_value: Any | None

metadata

General metadata for the parameter.

metadata: _models.ParameterDefinitionsValueMetadata | None

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 | None

type

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

type: str | _models.ParameterType | None