Share via


ApiExternalDocumentation Class

Definition

Additional, external documentation for the API.

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

Constructors

ApiExternalDocumentation(Uri)

Initializes a new instance of ApiExternalDocumentation.

Properties

Description

Description of the documentation.

Title

Title of the documentation.

Uri

URL pointing to the documentation.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<ApiExternalDocumentation>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ApiExternalDocumentation>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ApiExternalDocumentation>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ApiExternalDocumentation>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ApiExternalDocumentation>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to