Share via


ParameterExampleContract Class

Definition

Parameter example.

public class ParameterExampleContract : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.Models.ParameterExampleContract>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.Models.ParameterExampleContract>
type ParameterExampleContract = class
    interface IJsonModel<ParameterExampleContract>
    interface IPersistableModel<ParameterExampleContract>
Public Class ParameterExampleContract
Implements IJsonModel(Of ParameterExampleContract), IPersistableModel(Of ParameterExampleContract)
Inheritance
ParameterExampleContract
Implements

Constructors

ParameterExampleContract()

Initializes a new instance of ParameterExampleContract.

Properties

Description

Long description for the example.

ExternalValue

A URL that points to the literal example.

Summary

Short description for the example.

Value

Example value. May be a primitive value, or an object.

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" }.

Explicit Interface Implementations

IJsonModel<ParameterExampleContract>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ParameterExampleContract>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ParameterExampleContract>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ParameterExampleContract>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ParameterExampleContract>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to