1. Packages
  2. Nutanix
  3. API Docs
  4. getImage
Viewing docs for Nutanix v0.11.0
published on Monday, Nov 24, 2025 by Piers Karsenbarg
Schema (JSON)
pierskarsenbarg/pulumi-nutanix

nutanix.getImage

nutanix logo
Viewing docs for Nutanix v0.11.0
published on Monday, Nov 24, 2025 by Piers Karsenbarg
Schema (JSON)
pierskarsenbarg/pulumi-nutanix

    Describes a Image

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pierskarsenbarg/nutanix";

const testImage = new nutanix.Image("test", {
    name: "Ubuntu",
    description: "Ubuntu",
    sourceUri: "http://archive.ubuntu.com/ubuntu/dists/bionic/main/installer-amd64/current/images/netboot/mini.iso",
});
const test = nutanix.getImageOutput({
    imageId: testImage.id,
});
const testname = nutanix.getImageOutput({
    imageName: testImage.name,
});

    import pulumi
import pulumi_nutanix as nutanix

test_image = nutanix.Image("test",
    name="Ubuntu",
    description="Ubuntu",
    source_uri="http://archive.ubuntu.com/ubuntu/dists/bionic/main/installer-amd64/current/images/netboot/mini.iso")
test = nutanix.get_image_output(image_id=test_image.id)
testname = nutanix.get_image_output(image_name=test_image.name)

    package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testImage, err := nutanix.NewImage(ctx, "test", &nutanix.ImageArgs{
			Name:        pulumi.String("Ubuntu"),
			Description: pulumi.String("Ubuntu"),
			SourceUri:   pulumi.String("http://archive.ubuntu.com/ubuntu/dists/bionic/main/installer-amd64/current/images/netboot/mini.iso"),
		})
		if err != nil {
			return err
		}
		_ = nutanix.LookupImageOutput(ctx, nutanix.GetImageOutputArgs{
			ImageId: testImage.ID(),
		}, nil)
		_ = nutanix.LookupImageOutput(ctx, nutanix.GetImageOutputArgs{
			ImageName: testImage.Name,
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = PiersKarsenbarg.Nutanix;
using Nutanix = Pulumi.Nutanix;

return await Deployment.RunAsync(() => 
{
    var testImage = new Nutanix.Image("test", new()
    {
        Name = "Ubuntu",
        Description = "Ubuntu",
        SourceUri = "http://archive.ubuntu.com/ubuntu/dists/bionic/main/installer-amd64/current/images/netboot/mini.iso",
    });

    var test = Nutanix.GetImage.Invoke(new()
    {
        ImageId = testImage.Id,
    });

    var testname = Nutanix.GetImage.Invoke(new()
    {
        ImageName = testImage.Name,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.Image;
import com.pulumi.nutanix.ImageArgs;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetImageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testImage = new Image("testImage", ImageArgs.builder()
            .name("Ubuntu")
            .description("Ubuntu")
            .sourceUri("http://archive.ubuntu.com/ubuntu/dists/bionic/main/installer-amd64/current/images/netboot/mini.iso")
            .build());

        final var test = NutanixFunctions.getImage(GetImageArgs.builder()
            .imageId(testImage.id())
            .build());

        final var testname = NutanixFunctions.getImage(GetImageArgs.builder()
            .imageName(testImage.name())
            .build());

    }
}

    resources:
  testImage:
    type: nutanix:Image
    name: test
    properties:
      name: Ubuntu
      description: Ubuntu
      sourceUri: http://archive.ubuntu.com/ubuntu/dists/bionic/main/installer-amd64/current/images/netboot/mini.iso
variables:
  test:
    fn::invoke:
      function: nutanix:getImage
      arguments:
        imageId: ${testImage.id}
  testname:
    fn::invoke:
      function: nutanix:getImage
      arguments:
        imageName: ${testImage.name}

    Using getImage

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getImage(args: GetImageArgs, opts?: InvokeOptions): Promise<GetImageResult>
function getImageOutput(args: GetImageOutputArgs, opts?: InvokeOptions): Output<GetImageResult>
    def get_image(categories: Optional[Sequence[GetImageCategory]] = None,
              image_id: Optional[str] = None,
              image_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetImageResult
def get_image_output(categories: Optional[pulumi.Input[Sequence[pulumi.Input[GetImageCategoryArgs]]]] = None,
              image_id: Optional[pulumi.Input[str]] = None,
              image_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetImageResult]
    func LookupImage(ctx *Context, args *LookupImageArgs, opts ...InvokeOption) (*LookupImageResult, error)
func LookupImageOutput(ctx *Context, args *LookupImageOutputArgs, opts ...InvokeOption) LookupImageResultOutput

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

    public static class GetImage 
{
    public static Task<GetImageResult> InvokeAsync(GetImageArgs args, InvokeOptions? opts = null)
    public static Output<GetImageResult> Invoke(GetImageInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
public static Output<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)

    fn::invoke:
  function: nutanix:index/getImage:getImage
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Categories List<PiersKarsenbarg.Nutanix.Inputs.GetImageCategory>
    • Categories for the image.
    ImageId string
    Represents image UUID
    ImageName string
    Represents image name
    Categories []GetImageCategory
    • Categories for the image.
    ImageId string
    Represents image UUID
    ImageName string
    Represents image name
    categories List<GetImageCategory>
    • Categories for the image.
    imageId String
    Represents image UUID
    imageName String
    Represents image name
    categories GetImageCategory[]
    • Categories for the image.
    imageId string
    Represents image UUID
    imageName string
    Represents image name
    categories Sequence[GetImageCategory]
    • Categories for the image.
    image_id str
    Represents image UUID
    image_name str
    Represents image name
    categories List<Property Map>
    • Categories for the image.
    imageId String
    Represents image UUID
    imageName String
    Represents image name

    getImage Result

    The following output properties are available:

    ApiVersion string
    Architecture string
    • The supported CPU architecture for a disk image.
    AvailabilityZoneReference Dictionary<string, string>
    • The reference to a availability_zone.
    Categories List<PiersKarsenbarg.Nutanix.Outputs.GetImageCategory>
    • Categories for the image.
    Checksum Dictionary<string, string>
    • Checksum of the image. The checksum is used for image validation if the image has a source specified. For images that do not have their source specified the checksum is generated by the image service.
    ClusterName string
    ClusterReferences List<PiersKarsenbarg.Nutanix.Outputs.GetImageClusterReference>
    ClusterUuid string
    CurrentClusterReferenceLists List<PiersKarsenbarg.Nutanix.Outputs.GetImageCurrentClusterReferenceList>
    DataSourceReferences List<PiersKarsenbarg.Nutanix.Outputs.GetImageDataSourceReference>
    • Reference to a data source.
    Description string
    • A description for image.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageType string
    • The type of image.
    Metadata Dictionary<string, string>
    • The image kind metadata.
    Name string
    • the name.
    OwnerReference Dictionary<string, string>
    • The reference to a user.
    ProjectReference Dictionary<string, string>
    • The reference to a project.
    RetrievalUriLists List<string>
    • List of URIs where the raw image data can be accessed.
    SizeBytes int
    • The size of the image in bytes.
    SourceUri string
    • The source URI points at the location of the source image which is used to create/update image.
    State string
    • The state of the image.
    Version Dictionary<string, string>
    • The image version.
    ImageId string
    ImageName string
    ApiVersion string
    Architecture string
    • The supported CPU architecture for a disk image.
    AvailabilityZoneReference map[string]string
    • The reference to a availability_zone.
    Categories []GetImageCategory
    • Categories for the image.
    Checksum map[string]string
    • Checksum of the image. The checksum is used for image validation if the image has a source specified. For images that do not have their source specified the checksum is generated by the image service.
    ClusterName string
    ClusterReferences []GetImageClusterReference
    ClusterUuid string
    CurrentClusterReferenceLists []GetImageCurrentClusterReferenceList
    DataSourceReferences []GetImageDataSourceReference
    • Reference to a data source.
    Description string
    • A description for image.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageType string
    • The type of image.
    Metadata map[string]string
    • The image kind metadata.
    Name string
    • the name.
    OwnerReference map[string]string
    • The reference to a user.
    ProjectReference map[string]string
    • The reference to a project.
    RetrievalUriLists []string
    • List of URIs where the raw image data can be accessed.
    SizeBytes int
    • The size of the image in bytes.
    SourceUri string
    • The source URI points at the location of the source image which is used to create/update image.
    State string
    • The state of the image.
    Version map[string]string
    • The image version.
    ImageId string
    ImageName string
    apiVersion String
    architecture String
    • The supported CPU architecture for a disk image.
    availabilityZoneReference Map<String,String>
    • The reference to a availability_zone.
    categories List<GetImageCategory>
    • Categories for the image.
    checksum Map<String,String>
    • Checksum of the image. The checksum is used for image validation if the image has a source specified. For images that do not have their source specified the checksum is generated by the image service.
    clusterName String
    clusterReferences List<GetImageClusterReference>
    clusterUuid String
    currentClusterReferenceLists List<GetImageCurrentClusterReferenceList>
    dataSourceReferences List<GetImageDataSourceReference>
    • Reference to a data source.
    description String
    • A description for image.
    id String
    The provider-assigned unique ID for this managed resource.
    imageType String
    • The type of image.
    metadata Map<String,String>
    • The image kind metadata.
    name String
    • the name.
    ownerReference Map<String,String>
    • The reference to a user.
    projectReference Map<String,String>
    • The reference to a project.
    retrievalUriLists List<String>
    • List of URIs where the raw image data can be accessed.
    sizeBytes Integer
    • The size of the image in bytes.
    sourceUri String
    • The source URI points at the location of the source image which is used to create/update image.
    state String
    • The state of the image.
    version Map<String,String>
    • The image version.
    imageId String
    imageName String
    apiVersion string
    architecture string
    • The supported CPU architecture for a disk image.
    availabilityZoneReference {[key: string]: string}
    • The reference to a availability_zone.
    categories GetImageCategory[]
    • Categories for the image.
    checksum {[key: string]: string}
    • Checksum of the image. The checksum is used for image validation if the image has a source specified. For images that do not have their source specified the checksum is generated by the image service.
    clusterName string
    clusterReferences GetImageClusterReference[]
    clusterUuid string
    currentClusterReferenceLists GetImageCurrentClusterReferenceList[]
    dataSourceReferences GetImageDataSourceReference[]
    • Reference to a data source.
    description string
    • A description for image.
    id string
    The provider-assigned unique ID for this managed resource.
    imageType string
    • The type of image.
    metadata {[key: string]: string}
    • The image kind metadata.
    name string
    • the name.
    ownerReference {[key: string]: string}
    • The reference to a user.
    projectReference {[key: string]: string}
    • The reference to a project.
    retrievalUriLists string[]
    • List of URIs where the raw image data can be accessed.
    sizeBytes number
    • The size of the image in bytes.
    sourceUri string
    • The source URI points at the location of the source image which is used to create/update image.
    state string
    • The state of the image.
    version {[key: string]: string}
    • The image version.
    imageId string
    imageName string
    api_version str
    architecture str
    • The supported CPU architecture for a disk image.
    availability_zone_reference Mapping[str, str]
    • The reference to a availability_zone.
    categories Sequence[GetImageCategory]
    • Categories for the image.
    checksum Mapping[str, str]
    • Checksum of the image. The checksum is used for image validation if the image has a source specified. For images that do not have their source specified the checksum is generated by the image service.
    cluster_name str
    cluster_references Sequence[GetImageClusterReference]
    cluster_uuid str
    current_cluster_reference_lists Sequence[GetImageCurrentClusterReferenceList]
    data_source_references Sequence[GetImageDataSourceReference]
    • Reference to a data source.
    description str
    • A description for image.
    id str
    The provider-assigned unique ID for this managed resource.
    image_type str
    • The type of image.
    metadata Mapping[str, str]
    • The image kind metadata.
    name str
    • the name.
    owner_reference Mapping[str, str]
    • The reference to a user.
    project_reference Mapping[str, str]
    • The reference to a project.
    retrieval_uri_lists Sequence[str]
    • List of URIs where the raw image data can be accessed.
    size_bytes int
    • The size of the image in bytes.
    source_uri str
    • The source URI points at the location of the source image which is used to create/update image.
    state str
    • The state of the image.
    version Mapping[str, str]
    • The image version.
    image_id str
    image_name str
    apiVersion String
    architecture String
    • The supported CPU architecture for a disk image.
    availabilityZoneReference Map<String>
    • The reference to a availability_zone.
    categories List<Property Map>
    • Categories for the image.
    checksum Map<String>
    • Checksum of the image. The checksum is used for image validation if the image has a source specified. For images that do not have their source specified the checksum is generated by the image service.
    clusterName String
    clusterReferences List<Property Map>
    clusterUuid String
    currentClusterReferenceLists List<Property Map>
    dataSourceReferences List<Property Map>
    • Reference to a data source.
    description String
    • A description for image.
    id String
    The provider-assigned unique ID for this managed resource.
    imageType String
    • The type of image.
    metadata Map<String>
    • The image kind metadata.
    name String
    • the name.
    ownerReference Map<String>
    • The reference to a user.
    projectReference Map<String>
    • The reference to a project.
    retrievalUriLists List<String>
    • List of URIs where the raw image data can be accessed.
    sizeBytes Number
    • The size of the image in bytes.
    sourceUri String
    • The source URI points at the location of the source image which is used to create/update image.
    state String
    • The state of the image.
    version Map<String>
    • The image version.
    imageId String
    imageName String

    Supporting Types

    GetImageCategory

    Name string
    • the name.
    Value string
    Name string
    • the name.
    Value string
    name String
    • the name.
    value String
    name string
    • the name.
    value string
    name str
    • the name.
    value str
    name String
    • the name.
    value String

    GetImageClusterReference

    Kind string
    • The kind name (Default value: project).
    Name string
    • the name.
    Uuid string
    • the UUID.
    Kind string
    • The kind name (Default value: project).
    Name string
    • the name.
    Uuid string
    • the UUID.
    kind String
    • The kind name (Default value: project).
    name String
    • the name.
    uuid String
    • the UUID.
    kind string
    • The kind name (Default value: project).
    name string
    • the name.
    uuid string
    • the UUID.
    kind str
    • The kind name (Default value: project).
    name str
    • the name.
    uuid str
    • the UUID.
    kind String
    • The kind name (Default value: project).
    name String
    • the name.
    uuid String
    • the UUID.

    GetImageCurrentClusterReferenceList

    Kind string
    • The kind name (Default value: project).
    Name string
    • the name.
    Uuid string
    • the UUID.
    Kind string
    • The kind name (Default value: project).
    Name string
    • the name.
    Uuid string
    • the UUID.
    kind String
    • The kind name (Default value: project).
    name String
    • the name.
    uuid String
    • the UUID.
    kind string
    • The kind name (Default value: project).
    name string
    • the name.
    uuid string
    • the UUID.
    kind str
    • The kind name (Default value: project).
    name str
    • the name.
    uuid str
    • the UUID.
    kind String
    • The kind name (Default value: project).
    name String
    • the name.
    uuid String
    • the UUID.

    GetImageDataSourceReference

    Kind string
    • The kind name (Default value: project).
    Uuid string
    • the UUID.
    Kind string
    • The kind name (Default value: project).
    Uuid string
    • the UUID.
    kind String
    • The kind name (Default value: project).
    uuid String
    • the UUID.
    kind string
    • The kind name (Default value: project).
    uuid string
    • the UUID.
    kind str
    • The kind name (Default value: project).
    uuid str
    • the UUID.
    kind String
    • The kind name (Default value: project).
    uuid String
    • the UUID.

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Viewing docs for Nutanix v0.11.0
    published on Monday, Nov 24, 2025 by Piers Karsenbarg
    Schema (JSON)
    pierskarsenbarg/pulumi-nutanix
      Try Pulumi Cloud free. Your team will thank you.