Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. getImage
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.getImage

Explore with Pulumi AI

nutanix logo
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

    Describes a Image

    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>
    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
    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>
    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[]
    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]
    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>
    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.

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
    pierskarsenbarg/pulumi-nutanix