Share via


ApiManagementGlobalSchemaData Class

Definition

A class representing the ApiManagementGlobalSchema data model. Global Schema Contract details.

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

Constructors

ApiManagementGlobalSchemaData()

Initializes a new instance of ApiManagementGlobalSchemaData.

Properties

Description

Free-form schema entity description.

Document

Global Schema document object for json-based schema formats(e.g. json schema).

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

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Name

The name of the resource.

(Inherited from ResourceData)
ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
SchemaType

Schema Type. Immutable.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Value

Json-encoded string for non json-based schema.

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResourceData)

Explicit Interface Implementations

IJsonModel<ApiManagementGlobalSchemaData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ApiManagementGlobalSchemaData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ApiManagementGlobalSchemaData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ApiManagementGlobalSchemaData>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ApiManagementGlobalSchemaData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to