Share via


ParameterDefinition Class

Definition

Represent a parameter with constrains and metadata.

public class ParameterDefinition
type ParameterDefinition = class
Public Class ParameterDefinition
Inheritance
ParameterDefinition

Constructors

ParameterDefinition(TemplateParameterType)

Initializes a new instance of ParameterDefinition.

Properties

AllowedValues

Array of allowed values for this parameter.

To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

DefaultValue

Default Value for this parameter.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

Description

Description of this parameter/resourceGroup.

DisplayName

DisplayName of this parameter/resourceGroup.

StrongType

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

TemplateParameterType

Allowed data types for Resource Manager template parameters.

Applies to