ParameterDefinition Class

Definition

Namespace:

Azure.ResourceManager.Blueprint.Models

Assembly:

Azure.ResourceManager.Blueprint.dll

Package:

Azure.ResourceManager.Blueprint v1.0.0-beta.5

Source:

ParameterDefinition.cs

Represent a parameter with constrains and metadata.

public class ParameterDefinition : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Blueprint.Models.ParameterDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Blueprint.Models.ParameterDefinition>

type ParameterDefinition = class
    interface IJsonModel<ParameterDefinition>
    interface IPersistableModel<ParameterDefinition>

Public Class ParameterDefinition
Implements IJsonModel(Of ParameterDefinition), IPersistableModel(Of ParameterDefinition)

Inheritance

Object

ParameterDefinition

Implements

IJsonModel<ParameterDefinition> IPersistableModel<ParameterDefinition> IPersistableModel<T>

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.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<ParameterDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ParameterDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ParameterDefinition>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ParameterDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ParameterDefinition>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.