Share via

ParameterDefinitionsValue Class

  • Reference

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

Inheritance
azure.mgmt.resource.policy._serialization.Model
ParameterDefinitionsValue

Constructor

ParameterDefinitionsValue(*, type: str | _models.ParameterType | None = None, allowed_values: List[MutableMapping[str, Any]] | None = None, default_value: MutableMapping[str, Any] | None = None, schema: MutableMapping[str, Any] | None = None, metadata: _models.ParameterDefinitionsValueMetadata | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
type
str or ParameterType

The data type of the parameter. Known values are: "String", "Array", "Object", "Boolean", "Integer", "Float", and "DateTime".
allowed_values
list[<xref:JSON>]

The allowed values for the parameter.
default_value
<xref:JSON>

The default value for the parameter if no value is provided.
schema
<xref:JSON>

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
ParameterDefinitionsValueMetadata

General metadata for the parameter.

Variables

Name Description
type
str or ParameterType

The data type of the parameter. Known values are: "String", "Array", "Object", "Boolean", "Integer", "Float", and "DateTime".
allowed_values
list[<xref:JSON>]

The allowed values for the parameter.
default_value
<xref:JSON>

The default value for the parameter if no value is provided.
schema
<xref:JSON>

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
ParameterDefinitionsValueMetadata

General metadata for the parameter.