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, "stateOverride": { "locationRolloutPolicies": { string: string, ... }, "defaultRolloutTime": 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 } ] }, "rolloutOverride": { "locationRolloutPolicies": { string: string, ... }, "defaultRolloutTime": string }, "satisfiesPzs": boolean, "locked": boolean, "architecture": enum, "userLicenses": [ string ], "enableConfidentialCompute": boolean, "satisfiesPzi": boolean } |
Fields | |
---|---|
kind |
[Output Only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
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 |
description |
An optional description of this resource. Provide this property when you create the resource. |
sourceType |
The type of the image used to create this disk. The default and only valid value is |
rawDisk |
The parameters of the raw disk image. |
rawDisk.source |
The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL:
In order to create an image, you must provide the full or partial URL of one of the following:
|
rawDisk.sha1Checksum |
[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 |
The format used to encode and transmit the block device, which should be |
deprecated |
The deprecation status associated with this image. |
deprecated.state |
The deprecation state of this resource. This can be |
deprecated.replacement |
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 |
An optional RFC3339 timestamp on or after which the state of this resource is intended to change to |
deprecated.obsolete |
An optional RFC3339 timestamp on or after which the state of this resource is intended to change to |
deprecated.deleted |
An optional RFC3339 timestamp on or after which the state of this resource is intended to change to |
deprecated.stateOverride |
The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state. The rollout policy for this deprecation 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 |
deprecated.stateOverride.locationRolloutPolicies |
Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location. |
deprecated.stateOverride.defaultRolloutTime |
An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated. |
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 |
archiveSizeBytes |
Size of the image |
diskSizeGb |
Size of the image when restored onto a persistent disk (in GB). |
sourceDisk |
URL of the source disk used to create this image. For example, the following are valid values:
In order to create an image, you must provide the full or partial URL of one of the following:
|
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. |
licenses[] |
Any applicable license URI. |
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, 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 |
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 |
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": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
imageEncryptionKey.rsaEncryptedKey |
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 "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
imageEncryptionKey.kmsKeyName |
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/key "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 |
imageEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
imageEncryptionKey.kmsKeyServiceAccount |
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 |
The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. |
sourceDiskEncryptionKey.rawKey |
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": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
sourceDiskEncryptionKey.rsaEncryptedKey |
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 "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
sourceDiskEncryptionKey.kmsKeyName |
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/key "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 |
sourceDiskEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
sourceDiskEncryptionKey.kmsKeyServiceAccount |
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 |
[Output Only] Server-defined URL for the resource. |
labels |
Labels to apply to this image. These can be later modified by the |
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 To see the latest fingerprint, make a A base64-encoded 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 |
The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values:
|
licenseCodes[] |
Integer license codes indicating which licenses are attached to this image. |
sourceImage |
URL of the source image used to create this image. The following are valid formats for the URL:
In order to create an image, you must provide the full or partial URL of one of the following:
|
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. |
sourceImageEncryptionKey |
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. |
sourceImageEncryptionKey.rawKey |
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": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
sourceImageEncryptionKey.rsaEncryptedKey |
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 "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
sourceImageEncryptionKey.kmsKeyName |
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/key "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 |
sourceImageEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
sourceImageEncryptionKey.kmsKeyServiceAccount |
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 |
URL of the source snapshot used to create this image. The following are valid formats for the URL:
In order to create an image, you must provide the full or partial URL of one of the following:
|
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. |
sourceSnapshotEncryptionKey |
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. |
sourceSnapshotEncryptionKey.rawKey |
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": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
sourceSnapshotEncryptionKey.rsaEncryptedKey |
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 "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
sourceSnapshotEncryptionKey.kmsKeyName |
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/key "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 |
sourceSnapshotEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
sourceSnapshotEncryptionKey.kmsKeyServiceAccount |
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[] |
Cloud Storage bucket storage location of the image (regional or multi-regional). |
shieldedInstanceInitialState |
Set the secure boot keys of shielded instance. |
shieldedInstanceInitialState.pk |
The Platform Key (PK). |
shieldedInstanceInitialState.pk.content |
The raw content in the secure keys file. A base64-encoded string. |
shieldedInstanceInitialState.pk.fileType |
The file type of source file. |
shieldedInstanceInitialState.keks[] |
The Key Exchange Key (KEK). |
shieldedInstanceInitialState.keks[].content |
The raw content in the secure keys file. A base64-encoded string. |
shieldedInstanceInitialState.keks[].fileType |
The file type of source file. |
shieldedInstanceInitialState.dbs[] |
The Key Database (db). |
shieldedInstanceInitialState.dbs[].content |
The raw content in the secure keys file. A base64-encoded string. |
shieldedInstanceInitialState.dbs[].fileType |
The file type of source file. |
shieldedInstanceInitialState.dbxs[] |
The forbidden key database (dbx). |
shieldedInstanceInitialState.dbxs[].content |
The raw content in the secure keys file. A base64-encoded string. |
shieldedInstanceInitialState.dbxs[].fileType |
The file type of source file. |
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 |
rolloutOverride.locationRolloutPolicies |
Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location. |
rolloutOverride.defaultRolloutTime |
An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated. |
satisfiesPzs |
[Output Only] Reserved for future use. |
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:
The image with the locked field set to true will be prohibited from performing the operations below:
The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below:
|
architecture |
The architecture of the image. Valid values are ARM64 or X86_64. |
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: |
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. |
satisfiesPzi |
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. |