Class Image

Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.

Inheritance
object
Image
Implements
Inherited Members
Namespace: Google.Apis.Compute.alpha.Data
Assembly: Google.Apis.Compute.alpha.dll
Syntax
public class Image : IDirectResponseSchema

Properties

Architecture

The architecture of the image. Valid values are ARM64 or X86_64.

Declaration
[JsonProperty("architecture")]
public virtual string Architecture { get; set; }
Property Value
Type Description
string

ArchiveSizeBytes

Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

Declaration
[JsonProperty("archiveSizeBytes")]
public virtual long? ArchiveSizeBytes { get; set; }
Property Value
Type Description
long?

CreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Declaration
[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }
Property Value
Type Description
string

Deprecated

The deprecation status associated with this image.

Declaration
[JsonProperty("deprecated")]
public virtual DeprecationStatus Deprecated { get; set; }
Property Value
Type Description
DeprecationStatus

Description

An optional description of this resource. Provide this property when you create the resource.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

DiskSizeGb

Size of the image when restored onto a persistent disk (in GB).

Declaration
[JsonProperty("diskSizeGb")]
public virtual long? DiskSizeGb { get; set; }
Property Value
Type Description
long?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EnableConfidentialCompute

Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.

Declaration
[JsonProperty("enableConfidentialCompute")]
public virtual bool? EnableConfidentialCompute { get; set; }
Property Value
Type Description
bool?

Family

The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

Declaration
[JsonProperty("family")]
public virtual string Family { get; set; }
Property Value
Type Description
string

GuestOsFeatures

A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter.

Declaration
[JsonProperty("guestOsFeatures")]
public virtual IList<GuestOsFeature> GuestOsFeatures { get; set; }
Property Value
Type Description
IList<GuestOsFeature>

Id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Declaration
[JsonProperty("id")]
public virtual ulong? Id { get; set; }
Property Value
Type Description
ulong?

ImageEncryptionKey

Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.

Declaration
[JsonProperty("imageEncryptionKey")]
public virtual CustomerEncryptionKey ImageEncryptionKey { get; set; }
Property Value
Type Description
CustomerEncryptionKey

Kind

[Output Only] Type of the resource. Always compute#image for images.

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
string

LabelFingerprint

A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image.

Declaration
[JsonProperty("labelFingerprint")]
public virtual string LabelFingerprint { get; set; }
Property Value
Type Description
string

Labels

Labels to apply to this image. These can be later modified by the setLabels method.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

LicenseCodes

Integer license codes indicating which licenses are attached to this image.

Declaration
[JsonProperty("licenseCodes")]
public virtual IList<long?> LicenseCodes { get; set; }
Property Value
Type Description
IList<long?>

Licenses

Any applicable license URI.

Declaration
[JsonProperty("licenses")]
public virtual IList<string> Licenses { get; set; }
Property Value
Type Description
IList<string>

Locked

A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true

Declaration
[JsonProperty("locked")]
public virtual bool? Locked { get; set; }
Property Value
Type Description
bool?

Name

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

RawDisk

The parameters of the raw disk image.

Declaration
[JsonProperty("rawDisk")]
public virtual Image.RawDiskData RawDisk { get; set; }
Property Value
Type Description
Image.RawDiskData

RolloutOverride

A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. The rollout policy for this image is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

Declaration
[JsonProperty("rolloutOverride")]
public virtual RolloutPolicy RolloutOverride { get; set; }
Property Value
Type Description
RolloutPolicy

SatisfiesPzi

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
Type Description
bool?

SatisfiesPzs

[Output Only] Reserved for future use.

Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
Type Description
bool?

[Output Only] Server-defined URL for the resource.

Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type Description
string

SelfLinkWithId

[Output Only] Server-defined URL for this resource's resource id.

Declaration
[JsonProperty("selfLinkWithId")]
public virtual string SelfLinkWithId { get; set; }
Property Value
Type Description
string

ShieldedInstanceInitialState

Set the secure boot keys of shielded instance.

Declaration
[JsonProperty("shieldedInstanceInitialState")]
public virtual InitialStateConfig ShieldedInstanceInitialState { get; set; }
Property Value
Type Description
InitialStateConfig

SourceDisk

URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Declaration
[JsonProperty("sourceDisk")]
public virtual string SourceDisk { get; set; }
Property Value
Type Description
string

SourceDiskEncryptionKey

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

Declaration
[JsonProperty("sourceDiskEncryptionKey")]
public virtual CustomerEncryptionKey SourceDiskEncryptionKey { get; set; }
Property Value
Type Description
CustomerEncryptionKey

SourceDiskId

[Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.

Declaration
[JsonProperty("sourceDiskId")]
public virtual string SourceDiskId { get; set; }
Property Value
Type Description
string

SourceImage

URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Declaration
[JsonProperty("sourceImage")]
public virtual string SourceImage { get; set; }
Property Value
Type Description
string

SourceImageEncryptionKey

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Declaration
[JsonProperty("sourceImageEncryptionKey")]
public virtual CustomerEncryptionKey SourceImageEncryptionKey { get; set; }
Property Value
Type Description
CustomerEncryptionKey

SourceImageId

[Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.

Declaration
[JsonProperty("sourceImageId")]
public virtual string SourceImageId { get; set; }
Property Value
Type Description
string

SourceSnapshot

URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Declaration
[JsonProperty("sourceSnapshot")]
public virtual string SourceSnapshot { get; set; }
Property Value
Type Description
string

SourceSnapshotEncryptionKey

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

Declaration
[JsonProperty("sourceSnapshotEncryptionKey")]
public virtual CustomerEncryptionKey SourceSnapshotEncryptionKey { get; set; }
Property Value
Type Description
CustomerEncryptionKey

SourceSnapshotId

[Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.

Declaration
[JsonProperty("sourceSnapshotId")]
public virtual string SourceSnapshotId { get; set; }
Property Value
Type Description
string

SourceType

The type of the image used to create this disk. The default and only valid value is RAW.

Declaration
[JsonProperty("sourceType")]
public virtual string SourceType { get; set; }
Property Value
Type Description
string

Status

[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.

Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type Description
string

StorageLocations

Cloud Storage bucket storage location of the image (regional or multi-regional).

Declaration
[JsonProperty("storageLocations")]
public virtual IList<string> StorageLocations { get; set; }
Property Value
Type Description
IList<string>

UserLicenses

A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch

Declaration
[JsonProperty("userLicenses")]
public virtual IList<string> UserLicenses { get; set; }
Property Value
Type Description
IList<string>

Implements