Class 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.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Inheritance

object

Image

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CoreService.Models

Assembly: OCI.DotNetSDK.Core.dll

Syntax

public class Image

Properties

AgentFeatures

Declaration

[JsonProperty(PropertyName = "agentFeatures")]
public InstanceAgentFeatures AgentFeatures { get; set; }

Property Value

Type	Description
InstanceAgentFeatures

BaseImageId

Declaration

[JsonProperty(PropertyName = "baseImageId")]
public string BaseImageId { get; set; }

Property Value

Type	Description
string	The OCID of the image originally used to launch the instance.

BillableSizeInGBs

Declaration

[JsonProperty(PropertyName = "billableSizeInGBs")]
public long? BillableSizeInGBs { get; set; }

Property Value

Type	Description
long?	The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

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

Remarks

Required

CreateImageAllowed

Declaration

[Required(ErrorMessage = "CreateImageAllowed is required.")]
[JsonProperty(PropertyName = "createImageAllowed")]
public bool? CreateImageAllowed { get; set; }

Property Value

Type	Description
bool?	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: true

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
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: My custom Oracle Linux image

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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: {"Department": "Finance"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the image.

Remarks

Required

LaunchMode

Declaration

[JsonProperty(PropertyName = "launchMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Image.LaunchModeEnum? LaunchMode { get; set; }

Property Value

Type Description

Type	Description
Image.LaunchModeEnum?	Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.

Image.LaunchModeEnum?

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

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

LaunchOptions

Declaration

[JsonProperty(PropertyName = "launchOptions")]
public LaunchOptions LaunchOptions { get; set; }

Property Value

Type	Description
LaunchOptions

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Image.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Image.LifecycleStateEnum?

Remarks

Required

ListingType

Declaration

[JsonProperty(PropertyName = "listingType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Image.ListingTypeEnum? ListingType { get; set; }

Property Value

Type	Description
Image.ListingTypeEnum?	The listing type of the image. The default value is "NONE".

OperatingSystem

Declaration

[Required(ErrorMessage = "OperatingSystem is required.")]
[JsonProperty(PropertyName = "operatingSystem")]
public string OperatingSystem { get; set; }

Property Value

Type	Description
string	The image's operating system. Example: Oracle Linux

Remarks

Required

OperatingSystemVersion

Declaration

[Required(ErrorMessage = "OperatingSystemVersion is required.")]
[JsonProperty(PropertyName = "operatingSystemVersion")]
public string OperatingSystemVersion { get; set; }

Property Value

Type	Description
string	The image's operating system version. Example: 7.2

Remarks

Required

SizeInMBs

Declaration

[JsonProperty(PropertyName = "sizeInMBs")]
public long? SizeInMBs { get; set; }

Property Value

Type	Description
long?	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: 47694

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required