Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Image

A boot disk image for launching an instance. For more information, see Overview of the Compute Service.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Properties

Optional agentFeatures

agentFeatures: model.InstanceAgentFeatures

Optional baseImageId

baseImageId: undefined | string

The OCID of the image originally used to launch the instance.

Optional billableSizeInGBs

billableSizeInGBs: undefined | number

The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes).

Example: {@code 100} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

compartmentId

compartmentId: string

The OCID of the compartment containing the instance you want to use as the basis for the image.

createImageAllowed

createImageAllowed: boolean

Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance.

Example: {@code true}

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional displayName

displayName: undefined | string

A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information.

You cannot use a platform image name as a custom image name.

Example: {@code My custom Oracle Linux image}

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the image.

Optional launchMode

launchMode: LaunchMode

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

  • {@code NATIVE} - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
  • {@code EMULATED} - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
  • {@code PARAVIRTUALIZED} - VM instances launch with paravirtualized devices using VirtIO drivers.
  • {@code CUSTOM} - VM instances launch with custom configuration settings specified in the {@code LaunchOptions} parameter.

Optional launchOptions

launchOptions: model.LaunchOptions

lifecycleState

lifecycleState: LifecycleState

Optional listingType

listingType: ListingType

The listing type of the image. The default value is "NONE".

operatingSystem

operatingSystem: string

The image's operating system.

Example: {@code Oracle Linux}

operatingSystemVersion

operatingSystemVersion: string

The image's operating system version.

Example: {@code 7.2}

Optional sizeInMBs

sizeInMBs: undefined | number

The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image.

Example: {@code 47694} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

timeCreated

timeCreated: Date

The date and time the image was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Image): object

getJsonObj

  • getJsonObj(obj: Image): object