Show / Hide Table of Contents

Class ParameterValue

Value for the specified parameter. Can be either 'value' or 'reference' but not both.

Inheritance
System.Object
ParameterValue
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.Blueprint.dll
Syntax
public class ParameterValue : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Blueprint.Models.ParameterValue>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Blueprint.Models.ParameterValue>

Constructors

ParameterValue()

Initializes a new instance of ParameterValue.

Declaration
public ParameterValue ();

Properties

Reference

Parameter value as reference type.

Declaration
public Azure.ResourceManager.Blueprint.Models.SecretValueReference Reference { get; set; }
Property Value
SecretValueReference

Value

Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.

To assign an object to this property use System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions).

To assign an already formatted json string to this property use System.BinaryData.FromString(System.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" }.

Declaration
public BinaryData Value { get; set; }
Property Value
System.BinaryData

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration
protected virtual void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The JSON writer.

System.ClientModel.Primitives.ModelReaderWriterOptions options

The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<ParameterValue>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration
Azure.ResourceManager.Blueprint.Models.ParameterValue IJsonModel<ParameterValue>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonReader reader

The System.Text.Json.Utf8JsonReader to read.

System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns
ParameterValue

A T representation of the JSON value.

Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<ParameterValue>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration
void IJsonModel<ParameterValue>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The System.Text.Json.Utf8JsonWriter to write into.

System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<ParameterValue>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.Blueprint.Models.ParameterValue IPersistableModel<ParameterValue>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.BinaryData data

The System.BinaryData to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns
ParameterValue

A T representation of the data.

Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<ParameterValue>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration
string IPersistableModel<ParameterValue>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.

Returns
System.String

The format that the model uses when communicating with the serivce.

IPersistableModel<ParameterValue>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<ParameterValue>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns
System.BinaryData

A binary representation of the written model.

Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

Back to top Azure SDK for .NET