Share via


ApiCenterApiProperties Class

Definition

API properties.

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

Constructors

ApiCenterApiProperties(String, ApiKind)

Initializes a new instance of ApiCenterApiProperties.

Properties

Contacts

The set of contacts.

CustomProperties

The custom metadata defined for API catalog entities.

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 the API.

ExternalDocumentation

The set of external documentation.

Kind

Kind of API. For example, REST or GraphQL.

License

The license information for the API.

LifecycleStage

Current lifecycle stage of the API.

Summary

Short description of the API.

TermsOfServiceUri

URL pointing to the terms of service.

Title

API title.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<ApiCenterApiProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ApiCenterApiProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ApiCenterApiProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ApiCenterApiProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ApiCenterApiProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to