Skip to main content

images

Creates, updates, deletes, gets or lists an images resource.

Overview​

Nameimages
TypeResource
Idgoogle.compute.images

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstring (uint64)Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
namestringName of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
architecturestringThe architecture of the image. Valid values are ARM64 or X86_64. (ARCHITECTURE_UNSPECIFIED, ARM64, X86_64)
archiveSizeBytesstring (int64)Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
creationTimestampstringOutput only. [Output Only] Creation timestamp inRFC3339 text format.
deprecatedobjectOutput only. The deprecation status associated with this image. (id: DeprecationStatus)
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
diskSizeGbstring (int64)Size of the image when restored onto a persistent disk (in GB).
enableConfidentialComputebooleanOutput only. Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.
familystringThe 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.
guestOsFeaturesarrayA list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see theguestOSfeatures[].type parameter.
imageEncryptionKeyobjectEncrypts the image using acustomer-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. (id: CustomerEncryptionKey)
kindstringOutput only. [Output Only] Type of the resource. Always compute#image for images. (default: compute#image)
labelFingerprintstring (byte)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 error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image.
labelsobjectLabels to apply to this image. These can be later modified by the setLabels method.
licenseCodesarrayInteger license codes indicating which licenses are attached to this image.
licensesarrayAny applicable license URI.
paramsobjectInput only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: ImageParams)
rawDiskobjectThe parameters of the raw disk image.
satisfiesPzibooleanOutput only. Reserved for future use.
satisfiesPzsbooleanOutput only. [Output Only] Reserved for future use.
selfLinkstringOutput only. [Output Only] Server-defined URL for the resource.
shieldedInstanceInitialStateobjectSet the secure boot keys of shielded instance. (id: InitialStateConfig)
sourceDiskstringURL 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
sourceDiskEncryptionKeyobjectThecustomer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. (id: CustomerEncryptionKey)
sourceDiskIdstringOutput only. [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.
sourceImagestringURL 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
sourceImageEncryptionKeyobjectThe customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. (id: CustomerEncryptionKey)
sourceImageIdstringOutput only. [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.
sourceSnapshotstringURL 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
sourceSnapshotEncryptionKeyobjectThe customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. (id: CustomerEncryptionKey)
sourceSnapshotIdstringOutput only. [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.
sourceTypestringThe type of the image used to create this disk. The default and only valid value is RAW. (RAW) (default: RAW)
statusstringOutput only. [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, orREADY. (DELETING, FAILED, PENDING, READY)
storageLocationsarrayCloud Storage bucket storage location of the image (regional or multi-regional).

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectproject, imageReturns the specified image.
get_from_familyselectproject, familyReturns the latest image that is part of an image family and is not
deprecated. For more information on image families, seePublic
image families documentation.
listselectprojectreturnPartialSuccess, maxResults, pageToken, filter, orderByRetrieves the list of custom images
available to the specified project. Custom images are images you
create that belong to your project. This method does not
get any images that belong to other projects, including publicly-available
images, like Debian 8. If you want to get a list of publicly-available
images, use this method to make a request to the respective image project,
such as debian-cloud or windows-cloud.
insertinsertprojectforceCreate, requestIdCreates an image in the specified project using the data included
in the request.
patchupdateproject, imagerequestIdPatches the specified image with the data included in the request.
Only the following fields can be modified: family, description,
deprecation status.
deletedeleteproject, imagerequestIdDeletes the specified image.
deprecateexecproject, imagerequestIdSets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead.
set_labelsexecproject, resourceSets the labels on an image. To learn more about labels, read theLabeling
Resources documentation.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
familystring
imagestring
projectstring
resourcestring
filterstring
forceCreateboolean
maxResultsinteger (uint32)
orderBystring
pageTokenstring
requestIdstring
returnPartialSuccessboolean

SELECT examples​

Returns the specified image.

SELECT
id,
name,
architecture,
archiveSizeBytes,
creationTimestamp,
deprecated,
description,
diskSizeGb,
enableConfidentialCompute,
family,
guestOsFeatures,
imageEncryptionKey,
kind,
labelFingerprint,
labels,
licenseCodes,
licenses,
params,
rawDisk,
satisfiesPzi,
satisfiesPzs,
selfLink,
shieldedInstanceInitialState,
sourceDisk,
sourceDiskEncryptionKey,
sourceDiskId,
sourceImage,
sourceImageEncryptionKey,
sourceImageId,
sourceSnapshot,
sourceSnapshotEncryptionKey,
sourceSnapshotId,
sourceType,
status,
storageLocations
FROM google.compute.images
WHERE project = '{{ project }}' -- required
AND image = '{{ image }}' -- required
;

INSERT examples​

Creates an image in the specified project using the data included
in the request.

INSERT INTO google.compute.images (
data__sourceSnapshotEncryptionKey,
data__description,
data__family,
data__imageEncryptionKey,
data__sourceSnapshot,
data__sourceDiskEncryptionKey,
data__name,
data__storageLocations,
data__sourceImage,
data__archiveSizeBytes,
data__sourceType,
data__rawDisk,
data__labels,
data__labelFingerprint,
data__shieldedInstanceInitialState,
data__guestOsFeatures,
data__licenseCodes,
data__params,
data__licenses,
data__diskSizeGb,
data__sourceImageEncryptionKey,
data__sourceDisk,
data__architecture,
project,
forceCreate,
requestId
)
SELECT 
'{{ sourceSnapshotEncryptionKey }}',
'{{ description }}',
'{{ family }}',
'{{ imageEncryptionKey }}',
'{{ sourceSnapshot }}',
'{{ sourceDiskEncryptionKey }}',
'{{ name }}',
'{{ storageLocations }}',
'{{ sourceImage }}',
'{{ archiveSizeBytes }}',
'{{ sourceType }}',
'{{ rawDisk }}',
'{{ labels }}',
'{{ labelFingerprint }}',
'{{ shieldedInstanceInitialState }}',
'{{ guestOsFeatures }}',
'{{ licenseCodes }}',
'{{ params }}',
'{{ licenses }}',
'{{ diskSizeGb }}',
'{{ sourceImageEncryptionKey }}',
'{{ sourceDisk }}',
'{{ architecture }}',
'{{ project }}',
'{{ forceCreate }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

UPDATE examples​

Patches the specified image with the data included in the request.
Only the following fields can be modified: family, description,
deprecation status.

UPDATE google.compute.images
SET 
data__sourceSnapshotEncryptionKey = '{{ sourceSnapshotEncryptionKey }}',
data__description = '{{ description }}',
data__family = '{{ family }}',
data__imageEncryptionKey = '{{ imageEncryptionKey }}',
data__sourceSnapshot = '{{ sourceSnapshot }}',
data__sourceDiskEncryptionKey = '{{ sourceDiskEncryptionKey }}',
data__name = '{{ name }}',
data__storageLocations = '{{ storageLocations }}',
data__sourceImage = '{{ sourceImage }}',
data__archiveSizeBytes = '{{ archiveSizeBytes }}',
data__sourceType = '{{ sourceType }}',
data__rawDisk = '{{ rawDisk }}',
data__labels = '{{ labels }}',
data__labelFingerprint = '{{ labelFingerprint }}',
data__shieldedInstanceInitialState = '{{ shieldedInstanceInitialState }}',
data__guestOsFeatures = '{{ guestOsFeatures }}',
data__licenseCodes = '{{ licenseCodes }}',
data__params = '{{ params }}',
data__licenses = '{{ licenses }}',
data__diskSizeGb = '{{ diskSizeGb }}',
data__sourceImageEncryptionKey = '{{ sourceImageEncryptionKey }}',
data__sourceDisk = '{{ sourceDisk }}',
data__architecture = '{{ architecture }}'
WHERE 
project = '{{ project }}' --required
AND image = '{{ image }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples​

Deletes the specified image.

DELETE FROM google.compute.images
WHERE project = '{{ project }}' --required
AND image = '{{ image }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods​

Sets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead.

EXEC google.compute.images.deprecate 
@project='{{ project }}' --required, 
@image='{{ image }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"state": "{{ state }}", 
"replacement": "{{ replacement }}", 
"deleted": "{{ deleted }}", 
"deprecated": "{{ deprecated }}", 
"obsolete": "{{ obsolete }}"
}'
;