Resource: Image
Represents an Image resource.
You can use images to create boot disks for your VM instances. For more information, read Images .
JSON representation |
---|
{ "kind" : string , "id" : string , "creationTimestamp" : string , "name" : string , "description" : string , "sourceType" : enum , "rawDisk" : { "source" : string , "sha1Checksum" : string , "containerType" : enum } , "deprecated" : { "state" : enum , "replacement" : string , "deprecated" : string , "obsolete" : string , "deleted" : string } , "status" : enum , "archiveSizeBytes" : string , "diskSizeGb" : string , "sourceDisk" : string , "sourceDiskId" : string , "licenses" : [ string ] , "family" : string , "imageEncryptionKey" : { "rawKey" : string , "rsaEncryptedKey" : string , "kmsKeyName" : string , "sha256" : string , "kmsKeyServiceAccount" : string } , "sourceDiskEncryptionKey" : { "rawKey" : string , "rsaEncryptedKey" : string , "kmsKeyName" : string , "sha256" : string , "kmsKeyServiceAccount" : string } , "selfLink" : string , "labels" : { string : string , ... } , "labelFingerprint" : string , "guestOsFeatures" : [ { "type" : enum } ] , "licenseCodes" : [ string ] , "sourceImage" : string , "sourceImageId" : string , "sourceImageEncryptionKey" : { "rawKey" : string , "rsaEncryptedKey" : string , "kmsKeyName" : string , "sha256" : string , "kmsKeyServiceAccount" : string } , "sourceSnapshot" : string , "sourceSnapshotId" : string , "sourceSnapshotEncryptionKey" : { "rawKey" : string , "rsaEncryptedKey" : string , "kmsKeyName" : string , "sha256" : string , "kmsKeyServiceAccount" : string } , "storageLocations" : [ string ] , "shieldedInstanceInitialState" : { "pk" : { "content" : string , "fileType" : enum } , "keks" : [ { "content" : string , "fileType" : enum } ] , "dbs" : [ { "content" : string , "fileType" : enum } ] , "dbxs" : [ { "content" : string , "fileType" : enum } ] } , "satisfiesPzs" : boolean , "architecture" : enum , "enableConfidentialCompute" : boolean , "satisfiesPzi" : boolean } |
kind
string
[Output Only] Type of the resource. Always compute#image
for images.
id
string ( uint64
format)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name
string
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.
description
string
An optional description of this resource. Provide this property when you create the resource.
sourceType
enum
The type of the image used to create this disk. The default and only valid value is RAW
.
rawDisk
object
The parameters of the raw disk image.
rawDisk.source
string
The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL:
-
https://storage.googleapis.com/ bucketName / image_archive_name
-
https://storage.googleapis.com/ bucketName / folder_name / image_archive_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
rawDisk.sha1Checksum
(deprecated)
string
[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
rawDisk.containerType
enum
The format used to encode and transmit the block device, which should be TAR
. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
deprecated
object
The deprecation status associated with this image.
deprecated.state
enum
The deprecation state of this resource. This can be ACTIVE
, DEPRECATED
, OBSOLETE
, or DELETED
. Operations which communicate the end of life date for an image, can use ACTIVE
. Operations which create a new resource using a DEPRECATED
resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE
or DELETED
resources will be rejected and result in an error.
deprecated.replacement
string
The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
deprecated.deprecated
string
An optional RFC3339
timestamp on or after which the state of this resource is intended to change to DEPRECATED
. This is only informational and the status will not change unless the client explicitly changes it.
deprecated.obsolete
string
An optional RFC3339
timestamp on or after which the state of this resource is intended to change to OBSOLETE
. This is only informational and the status will not change unless the client explicitly changes it.
deprecated.deleted
string
An optional RFC3339
timestamp on or after which the state of this resource is intended to change to DELETED
. This is only informational and the status will not change unless the client explicitly changes it.
status
enum
[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
.
archiveSizeBytes
string ( int64
format)
Size of the image tar.gz
archive stored in Google Cloud Storage (in bytes).
diskSizeGb
string ( int64
format)
Size of the image when restored onto a persistent disk (in GB).
sourceDisk
string
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
sourceDiskId
string
[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.
licenses[]
string
Any applicable license URI.
family
string
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 .
imageEncryptionKey
object
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.
imageEncryptionKey.rawKey
string
Specifies a 256-bit customer-supplied encryption key
, encoded in RFC 4648 base64
to either encrypt or decrypt this resource. You can provide either the rawKey
or the rsaEncryptedKey
. For example:
"rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
imageEncryptionKey.rsaEncryptedKey
string
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key
to either encrypt or decrypt this resource. You can provide either the rawKey
or the rsaEncryptedKey
. For example:
"rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="The key must meet the following requirements before you can provide it to Compute Engine:
- The key is wrapped using a RSA public key certificate provided by Google.
- After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
imageEncryptionKey.kmsKeyName
string
The name of the encryption key that is stored in Google Cloud KMS. For example:
"kmsKeyName": "projects/ kms_project_id /locations/ region /keyRings/ key_region /cryptoKeys/ keyThe fully-qualifed key name may be returned for resource GET requests. For example:
"kmsKeyName": "projects/ kms_project_id /locations/ region /keyRings/ key_region /cryptoKeys/ key /cryptoKeyVersions/1
imageEncryptionKey.sha256
string
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
imageEncryptionKey.kmsKeyServiceAccount
string
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example:
"kmsKeyServiceAccount": " name @ projectId .iam.gserviceaccount.com/
sourceDiskEncryptionKey
object
The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
sourceDiskEncryptionKey.rawKey
string
Specifies a 256-bit customer-supplied encryption key
, encoded in RFC 4648 base64
to either encrypt or decrypt this resource. You can provide either the rawKey
or the rsaEncryptedKey
. For example:
"rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
sourceDiskEncryptionKey.rsaEncryptedKey
string
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key
to either encrypt or decrypt this resource. You can provide either the rawKey
or the rsaEncryptedKey
. For example:
"rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="The key must meet the following requirements before you can provide it to Compute Engine:
- The key is wrapped using a RSA public key certificate provided by Google.
- After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
sourceDiskEncryptionKey.kmsKeyName
string
The name of the encryption key that is stored in Google Cloud KMS. For example:
"kmsKeyName": "projects/ kms_project_id /locations/ region /keyRings/ key_region /cryptoKeys/ keyThe fully-qualifed key name may be returned for resource GET requests. For example:
"kmsKeyName": "projects/ kms_project_id /locations/ region /keyRings/ key_region /cryptoKeys/ key /cryptoKeyVersions/1
sourceDiskEncryptionKey.sha256
string
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
sourceDiskEncryptionKey.kmsKeyServiceAccount
string
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example:
"kmsKeyServiceAccount": " name @ projectId .iam.gserviceaccount.com/
selfLink
string
[Output Only] Server-defined URL for the resource.
labels
map (key: string, value: string)
Labels to apply to this image. These can be later modified by the setLabels
method.
labelFingerprint
string ( bytes
format)
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.
A base64-encoded string.
guestOsFeatures[]
object
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.
guestOsFeatures[].type
enum
The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values:
-
VIRTIO_SCSI_MULTIQUEUE
-
WINDOWS
-
MULTI_IP_SUBNET
-
UEFI_COMPATIBLE
-
GVNIC
-
SEV_CAPABLE
-
SUSPEND_RESUME_COMPATIBLE
-
SEV_LIVE_MIGRATABLE_V2
-
SEV_SNP_CAPABLE
-
TDX_CAPABLE
-
IDPF
licenseCodes[]
string ( int64
format)
Integer license codes indicating which licenses are attached to this image.
sourceImage
string
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/ projectId /global/ images/ image_name
-
projects/ projectId /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
sourceImageId
string
[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.
sourceImageEncryptionKey
object
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
sourceImageEncryptionKey.rawKey
string
Specifies a 256-bit customer-supplied encryption key
, encoded in RFC 4648 base64
to either encrypt or decrypt this resource. You can provide either the rawKey
or the rsaEncryptedKey
. For example:
"rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
sourceImageEncryptionKey.rsaEncryptedKey
string
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key
to either encrypt or decrypt this resource. You can provide either the rawKey
or the rsaEncryptedKey
. For example:
"rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="The key must meet the following requirements before you can provide it to Compute Engine:
- The key is wrapped using a RSA public key certificate provided by Google.
- After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
sourceImageEncryptionKey.kmsKeyName
string
The name of the encryption key that is stored in Google Cloud KMS. For example:
"kmsKeyName": "projects/ kms_project_id /locations/ region /keyRings/ key_region /cryptoKeys/ keyThe fully-qualifed key name may be returned for resource GET requests. For example:
"kmsKeyName": "projects/ kms_project_id /locations/ region /keyRings/ key_region /cryptoKeys/ key /cryptoKeyVersions/1
sourceImageEncryptionKey.sha256
string
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
sourceImageEncryptionKey.kmsKeyServiceAccount
string
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example:
"kmsKeyServiceAccount": " name @ projectId .iam.gserviceaccount.com/
sourceSnapshot
string
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/ projectId /global/ snapshots/ snapshot_name
-
projects/ projectId /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
sourceSnapshotId
string
[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.
sourceSnapshotEncryptionKey
object
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
sourceSnapshotEncryptionKey.rawKey
string
Specifies a 256-bit customer-supplied encryption key
, encoded in RFC 4648 base64
to either encrypt or decrypt this resource. You can provide either the rawKey
or the rsaEncryptedKey
. For example:
"rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
sourceSnapshotEncryptionKey.rsaEncryptedKey
string
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key
to either encrypt or decrypt this resource. You can provide either the rawKey
or the rsaEncryptedKey
. For example:
"rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="The key must meet the following requirements before you can provide it to Compute Engine:
- The key is wrapped using a RSA public key certificate provided by Google.
- After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
sourceSnapshotEncryptionKey.kmsKeyName
string
The name of the encryption key that is stored in Google Cloud KMS. For example:
"kmsKeyName": "projects/ kms_project_id /locations/ region /keyRings/ key_region /cryptoKeys/ keyThe fully-qualifed key name may be returned for resource GET requests. For example:
"kmsKeyName": "projects/ kms_project_id /locations/ region /keyRings/ key_region /cryptoKeys/ key /cryptoKeyVersions/1
sourceSnapshotEncryptionKey.sha256
string
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
sourceSnapshotEncryptionKey.kmsKeyServiceAccount
string
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example:
"kmsKeyServiceAccount": " name @ projectId .iam.gserviceaccount.com/
storageLocations[]
string
Cloud Storage bucket storage location of the image (regional or multi-regional).
shieldedInstanceInitialState
object
Set the secure boot keys of shielded instance.
shieldedInstanceInitialState.pk
object
The Platform Key (PK).
shieldedInstanceInitialState.pk.content
shieldedInstanceInitialState.pk.fileType
enum
The file type of source file.
shieldedInstanceInitialState.keks[]
object
The Key Exchange Key (KEK).
shieldedInstanceInitialState.keks[].content
shieldedInstanceInitialState.keks[].fileType
enum
The file type of source file.
shieldedInstanceInitialState.dbs[]
object
The Key Database (db).
shieldedInstanceInitialState.dbs[].content
shieldedInstanceInitialState.dbs[].fileType
enum
The file type of source file.
shieldedInstanceInitialState.dbxs[]
object
The forbidden key database (dbx).
shieldedInstanceInitialState.dbxs[].content
shieldedInstanceInitialState.dbxs[].fileType
enum
The file type of source file.
satisfiesPzs
boolean
[Output Only] Reserved for future use.
architecture
enum
The architecture of the image. Valid values are ARM64 or X86_64.
enableConfidentialCompute
boolean
Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.
satisfiesPzi
boolean
Output only. Reserved for future use.
Methods |
|
---|---|
|
Deletes the specified image. |
|
Sets the deprecation status of an image. |
|
Returns the specified image. |
|
Returns the latest image that is part of an image family and is not deprecated. |
|
Gets the access control policy for a resource. |
|
Creates an image in the specified project using the data included in the request. |
|
Retrieves the list of custom images available to the specified project. |
|
Patches the specified image with the data included in the request. |
|
Sets the access control policy on the specified resource. |
|
Sets the labels on an image. |
|
Returns permissions that a caller has on the specified resource. |