api

Documentation

Index

• Constants
• type DynamicResource
  • func (d *DynamicResource) ConvertFrom(src v1.DataModelInterface) error
  • func (d *DynamicResource) ConvertTo() (v1.DataModelInterface, error)

Constants

const (
	// TODO
	Version = "2023-01-01"
)

Types

type DynamicResource

type DynamicResource struct {
	// ID is the resource ID.
	ID *string `json:"id"`
	// Name is the resource name.
	Name *string `json:"name"`
	// Type is the resource type.
	Type *string `json:"type"`
	// Location is the resource location.
	Location *string `json:"location"`
	// Tags are the resource tags.
	Tags map[string]*string `json:"tags,omitempty"`
	// Properties stores the properties of the resource.
	Properties map[string]any `json:"properties,omitempty"`
	// SystemData stores the system data of the resource.
	SystemData map[string]any `json:"systemData,omitempty"`
}

DynamicResource is used as the versioned resource model for dynamic resources.

A dynamic resource uses a user-provided OpenAPI specification to define the resource schema. Therefore, the properties of the resource are not known at compile time.

func (*DynamicResource) ConvertFrom

func (d *DynamicResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts the datamodel to the versioned model.

func (*DynamicResource) ConvertTo

func (d *DynamicResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts the versioned model to the datamodel.