images

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

Overview

Name	images
Type	Resource
Id	google.compute.images

Fields

Name	Datatype	Description
id	string	[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.
architecture	string	The architecture of the image. Valid values are ARM64 or X86_64.
archiveSizeBytes	string	Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
deprecated	object	Deprecation status for a public resource.
diskSizeGb	string	Size of the image when restored onto a persistent disk (in GB).
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.
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.
guestOsFeatures	array	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.
imageEncryptionKey	object
kind	string	[Output Only] Type of the resource. Always compute#image for images.
labelFingerprint	string	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.
labels	object	Labels to apply to this image. These can be later modified by the setLabels method.
licenseCodes	array	Integer license codes indicating which licenses are attached to this image.
licenses	array	Any applicable license URI.
rawDisk	object	The parameters of the raw disk image.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	[Output Only] Reserved for future use.
selfLink	string	[Output Only] Server-defined URL for the resource.
shieldedInstanceInitialState	object	Initial State for shielded instance, these are public keys which are safe to store in public
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
sourceDiskEncryptionKey	object
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.
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/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
sourceImageEncryptionKey	object
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.
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/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
sourceSnapshotEncryptionKey	object
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.
sourceType	string	The type of the image used to create this disk. The default and only valid value is RAW.
status	string	[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.
storageLocations	array	Cloud Storage bucket storage location of the image (regional or multi-regional).

Methods

Name	Accessible by	Required Params	Description
get	SELECT	image, project	Returns the specified image.
list	SELECT	project	Retrieves 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.
insert	INSERT	project	Creates an image in the specified project using the data included in the request.
delete	DELETE	image, project	Deletes the specified image.
patch	UPDATE	image, project	Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.
deprecate	EXEC	image, project	Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.
set_labels	EXEC	project, resource	Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.

SELECT examples

Retrieves 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.

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

INSERT example

Use the following StackQL query and manifest file to create a new images resource.

All Properties

/*+ create */
INSERT INTO google.compute.images (
project,
name,
description,
sourceType,
rawDisk,
deprecated,
status,
archiveSizeBytes,
diskSizeGb,
sourceDisk,
sourceDiskId,
licenses,
family,
imageEncryptionKey,
sourceDiskEncryptionKey,
labels,
labelFingerprint,
guestOsFeatures,
licenseCodes,
sourceImage,
sourceImageId,
sourceImageEncryptionKey,
sourceSnapshot,
sourceSnapshotId,
sourceSnapshotEncryptionKey,
storageLocations,
shieldedInstanceInitialState,
satisfiesPzs,
architecture,
enableConfidentialCompute
)
SELECT 
'{{ project }}',
'{{ name }}',
'{{ description }}',
'{{ sourceType }}',
'{{ rawDisk }}',
'{{ deprecated }}',
'{{ status }}',
'{{ archiveSizeBytes }}',
'{{ diskSizeGb }}',
'{{ sourceDisk }}',
'{{ sourceDiskId }}',
'{{ licenses }}',
'{{ family }}',
'{{ imageEncryptionKey }}',
'{{ sourceDiskEncryptionKey }}',
'{{ labels }}',
'{{ labelFingerprint }}',
'{{ guestOsFeatures }}',
'{{ licenseCodes }}',
'{{ sourceImage }}',
'{{ sourceImageId }}',
'{{ sourceImageEncryptionKey }}',
'{{ sourceSnapshot }}',
'{{ sourceSnapshotId }}',
'{{ sourceSnapshotEncryptionKey }}',
'{{ storageLocations }}',
'{{ shieldedInstanceInitialState }}',
{{ satisfiesPzs }},
'{{ architecture }}',
{{ enableConfidentialCompute }}
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: sourceType
      value: string
    - name: rawDisk
      value:
        - name: source
          value: string
        - name: sha1Checksum
          value: string
        - name: containerType
          value: string
    - name: deprecated
      value:
        - name: state
          value: string
        - name: replacement
          value: string
        - name: deprecated
          value: string
        - name: obsolete
          value: string
        - name: deleted
          value: string
    - name: status
      value: string
    - name: archiveSizeBytes
      value: string
    - name: diskSizeGb
      value: string
    - name: sourceDisk
      value: string
    - name: sourceDiskId
      value: string
    - name: licenses
      value:
        - string
    - name: family
      value: string
    - name: imageEncryptionKey
      value:
        - name: rawKey
          value: string
        - name: rsaEncryptedKey
          value: string
        - name: kmsKeyName
          value: string
        - name: sha256
          value: string
        - name: kmsKeyServiceAccount
          value: string
    - name: selfLink
      value: string
    - name: labels
      value: object
    - name: labelFingerprint
      value: string
    - name: guestOsFeatures
      value:
        - - name: type
            value: string
    - name: licenseCodes
      value:
        - string
    - name: sourceImage
      value: string
    - name: sourceImageId
      value: string
    - name: sourceSnapshot
      value: string
    - name: sourceSnapshotId
      value: string
    - name: storageLocations
      value:
        - string
    - name: shieldedInstanceInitialState
      value:
        - name: pk
          value:
            - name: content
              value: string
            - name: fileType
              value: string
        - name: keks
          value:
            - - name: content
                value: string
              - name: fileType
                value: string
        - name: dbs
          value:
            - - name: content
                value: string
              - name: fileType
                value: string
        - name: dbxs
          value:
            - - name: content
                value: string
              - name: fileType
                value: string
    - name: satisfiesPzs
      value: boolean
    - name: architecture
      value: string
    - name: enableConfidentialCompute
      value: boolean
    - name: satisfiesPzi
      value: boolean

UPDATE example

Updates a images resource.

/*+ update */
UPDATE google.compute.images
SET 
name = '{{ name }}',
description = '{{ description }}',
sourceType = '{{ sourceType }}',
rawDisk = '{{ rawDisk }}',
deprecated = '{{ deprecated }}',
status = '{{ status }}',
archiveSizeBytes = '{{ archiveSizeBytes }}',
diskSizeGb = '{{ diskSizeGb }}',
sourceDisk = '{{ sourceDisk }}',
sourceDiskId = '{{ sourceDiskId }}',
licenses = '{{ licenses }}',
family = '{{ family }}',
imageEncryptionKey = '{{ imageEncryptionKey }}',
sourceDiskEncryptionKey = '{{ sourceDiskEncryptionKey }}',
labels = '{{ labels }}',
labelFingerprint = '{{ labelFingerprint }}',
guestOsFeatures = '{{ guestOsFeatures }}',
licenseCodes = '{{ licenseCodes }}',
sourceImage = '{{ sourceImage }}',
sourceImageId = '{{ sourceImageId }}',
sourceImageEncryptionKey = '{{ sourceImageEncryptionKey }}',
sourceSnapshot = '{{ sourceSnapshot }}',
sourceSnapshotId = '{{ sourceSnapshotId }}',
sourceSnapshotEncryptionKey = '{{ sourceSnapshotEncryptionKey }}',
storageLocations = '{{ storageLocations }}',
shieldedInstanceInitialState = '{{ shieldedInstanceInitialState }}',
satisfiesPzs = true|false,
architecture = '{{ architecture }}',
enableConfidentialCompute = true|false
WHERE 
image = '{{ image }}'
AND project = '{{ project }}';

DELETE example

Deletes the specified images resource.

/*+ delete */
DELETE FROM google.compute.images
WHERE image = '{{ image }}'
AND project = '{{ project }}';