GetImage

Get information about a Google Compute Image. Check that your service account has the compute.imageUser role if you want to share custom images from another project. If you want to use [public images][pubimg], do not forget to specify the dedicated project. For more information see the official documentation and its API.

Using GetImage

function getImage(args: GetImageArgs, opts?: InvokeOptions): Promise<GetImageResult>

function  get_image(family=None, name=None, project=None, opts=None)

func LookupImage(ctx *Context, args *LookupImageArgs, opts ...InvokeOption) (*LookupImageResult, error)

Note: This function is named LookupImage in the Go SDK.

public static class GetImage {
    public static Task<GetImageResult> InvokeAsync(GetImageArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Family string: The family name of the image.
Name string: or family - (Required) The name of a specific image or a family. Exactly one of name of family must be specified. If name is specified, it will fetch the corresponding image. If family is specified, it will returns the latest image that is part of an image family and is not deprecated.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used. If you are using a [public base image][pubimg], be sure to specify the correct Image Project.

Family string: The family name of the image.
Name string: or family - (Required) The name of a specific image or a family. Exactly one of name of family must be specified. If name is specified, it will fetch the corresponding image. If family is specified, it will returns the latest image that is part of an image family and is not deprecated.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used. If you are using a [public base image][pubimg], be sure to specify the correct Image Project.

family string: The family name of the image.
name string: or family - (Required) The name of a specific image or a family. Exactly one of name of family must be specified. If name is specified, it will fetch the corresponding image. If family is specified, it will returns the latest image that is part of an image family and is not deprecated.
project string: The project in which the resource belongs. If it is not provided, the provider project is used. If you are using a [public base image][pubimg], be sure to specify the correct Image Project.

family str: The family name of the image.
name str: or family - (Required) The name of a specific image or a family. Exactly one of name of family must be specified. If name is specified, it will fetch the corresponding image. If family is specified, it will returns the latest image that is part of an image family and is not deprecated.
project str: The project in which the resource belongs. If it is not provided, the provider project is used. If you are using a [public base image][pubimg], be sure to specify the correct Image Project.

GetImage Result

The following output properties are available:

ArchiveSizeBytes int: The size of the image tar.gz archive stored in Google Cloud Storage in bytes.
CreationTimestamp string: The creation timestamp in RFC3339 text format.
Description string: An optional description of this image.
DiskSizeGb int: The size of the image when restored onto a persistent disk in gigabytes.
Family string: The family name of the image.
Id string: The provider-assigned unique ID for this managed resource.
ImageEncryptionKeySha256 string: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this image.
ImageId string: The unique identifier for the image.
LabelFingerprint string: A fingerprint for the labels being applied to this image.
Labels Dictionary<string, string>: A map of labels applied to this image.
Licenses List<string>: A list of applicable license URI.
Name string: The name of the image.
Project string
SelfLink string: The URI of the image.
SourceDisk string: The URL of the source disk used to create this image.
SourceDiskEncryptionKeySha256 string: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this image.
SourceDiskId string: The ID value of the disk used to create this image.
SourceImageId string: The ID value of the image used to create this image.
Status string: The status of the image. Possible values are FAILED, PENDING, or READY.

ArchiveSizeBytes int: The size of the image tar.gz archive stored in Google Cloud Storage in bytes.
CreationTimestamp string: The creation timestamp in RFC3339 text format.
Description string: An optional description of this image.
DiskSizeGb int: The size of the image when restored onto a persistent disk in gigabytes.
Family string: The family name of the image.
Id string: The provider-assigned unique ID for this managed resource.
ImageEncryptionKeySha256 string: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this image.
ImageId string: The unique identifier for the image.
LabelFingerprint string: A fingerprint for the labels being applied to this image.
Labels map[string]string: A map of labels applied to this image.
Licenses []string: A list of applicable license URI.
Name string: The name of the image.
Project string
SelfLink string: The URI of the image.
SourceDisk string: The URL of the source disk used to create this image.
SourceDiskEncryptionKeySha256 string: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this image.
SourceDiskId string: The ID value of the disk used to create this image.
SourceImageId string: The ID value of the image used to create this image.
Status string: The status of the image. Possible values are FAILED, PENDING, or READY.

archiveSizeBytes number: The size of the image tar.gz archive stored in Google Cloud Storage in bytes.
creationTimestamp string: The creation timestamp in RFC3339 text format.
description string: An optional description of this image.
diskSizeGb number: The size of the image when restored onto a persistent disk in gigabytes.
family string: The family name of the image.
id string: The provider-assigned unique ID for this managed resource.
imageEncryptionKeySha256 string: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this image.
imageId string: The unique identifier for the image.
labelFingerprint string: A fingerprint for the labels being applied to this image.
labels {[key: string]: string}: A map of labels applied to this image.
licenses string[]: A list of applicable license URI.
name string: The name of the image.
project string
selfLink string: The URI of the image.
sourceDisk string: The URL of the source disk used to create this image.
sourceDiskEncryptionKeySha256 string: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this image.
sourceDiskId string: The ID value of the disk used to create this image.
sourceImageId string: The ID value of the image used to create this image.
status string: The status of the image. Possible values are FAILED, PENDING, or READY.

archive_size_bytes float: The size of the image tar.gz archive stored in Google Cloud Storage in bytes.
creation_timestamp str: The creation timestamp in RFC3339 text format.
description str: An optional description of this image.
disk_size_gb float: The size of the image when restored onto a persistent disk in gigabytes.
family str: The family name of the image.
id str: The provider-assigned unique ID for this managed resource.
image_encryption_key_sha256 str: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this image.
image_id str: The unique identifier for the image.
label_fingerprint str: A fingerprint for the labels being applied to this image.
labels Dict[str, str]: A map of labels applied to this image.
licenses List[str]: A list of applicable license URI.
name str: The name of the image.
project str
self_link str: The URI of the image.
source_disk str: The URL of the source disk used to create this image.
source_disk_encryption_key_sha256 str: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this image.
source_disk_id str: The ID value of the disk used to create this image.
source_image_id str: The ID value of the image used to create this image.
status str: The status of the image. Possible values are FAILED, PENDING, or READY.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetImage

Using GetImage

GetImage Result

Package Details

On This Page