ImageMappingDescription

Represents a fabric image from the corresponding cloud end-point with additional cloud configuration script that will be executed on provisioning

JSON Example

{
    "ubuntu": {
        "externalRegionId": "us-east-1",
        "externalId": "ami-2c7b5656",
        "name": "ami-ubuntu-16.04",
        "description": "instance-store - HVM - supports - UTF-8 - tools"
    }
}

string

Required

The id of this resource instance

string

createdAt

Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

string

updatedAt

Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string

owner

Optional

Email of the user or display name of the group that owns the entity.

string

ownerType

Optional

Type of a owner(user/ad_group) that owns the entity.

string

orgId

Optional

The id of the organization this entity belongs to.

object

_links

Required

HATEOAS of the entity

string

name

Optional

A human-friendly name used as an identifier in APIs that support this option.

string

description

Optional

A human-friendly description.

string

externalId

Optional

External entity Id on the provider side.

string

osFamily

Optional

Operating System family of the image.

string

externalRegionId

Optional

The regionId of the image

string

externalRegionName

Optional

The region name of the image

object

customProperties

Optional

Additional properties that may be used to extend the base type.

boolean

isPrivate

Optional

Indicates whether this fabric image is private. For vSphere, private images are considered to be templates and snapshots and public are Content Library Items

array of string

cloudAccountIds

Optional

Set of ids of the cloud accounts this entity belongs to.

string

cloudAccountName

Optional

Name of the cloud account this entity belongs to.

array of ImageDiskConfiguration

diskConfigs

Optional

List of disk config for the image

array of ImageNetworkConfiguration

networkConfigs

Optional

List of network config for the image

array of PlacementConstraint

constraints

Optional

Constraints that are used to drive placement policies for the image that is produced from this mapping.Constraint expressions are matched against tags on existing placement targets.

string

cloudConfig

Optional

Cloud config for this image. This cloud config will be merged during provisioning with other cloud configurations such as the bootConfig provided in MachineSpecification.