ImageMappingDescription

ImageMappingDescription

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

JSON Example

{
    "owner": "[email protected]",
    "cloudConfig": "runcmd:\n  - [\"mkdir\", \"/imageFolder\"]",
    "osFamily": "linux, win",
    "externalRegionId": "us-east-1",
    "description": "my-description",
    "externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
    "isPrivate": true,
    "orgId": "9e49",
    "organizationId": "deprecated",
    "createdAt": "2012-09-27",
    "cloudAccountIds": [
        "string"
    ],
    "name": "my-name",
    "id": "9e49",
    "updatedAt": "2012-09-27"
}

string

owner

Optional

Email of the user that owns the entity.

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.

string

osFamily

Optional

Operating System family of the image.

object

_links

Required

HATEOAS of the entity

string

externalRegionId

Optional

The regionId of the image

string

description

Optional

A human-friendly description.

string

externalId

Optional

External entity Id on the provider side.

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

string

orgId

Optional

The id of the organization this entity belongs to.

string

organizationId

Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

string

createdAt

Optional

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

array of string

cloudAccountIds

Optional

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

object

customProperties

Optional

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

string

name

Optional

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

string

id

Required

The id of this resource instance

string

updatedAt

Optional

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