Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gcore Provider
  3. API Docs
  4. getImage
gcore 0.19.0 published on Monday, Apr 14, 2025 by g-core
g-core/terraform-provider-gcore

gcore.getImage

Explore with Pulumi AI

gcore 0.19.0 published on Monday, Apr 14, 2025 by g-core
g-core/terraform-provider-gcore

Represent image data

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcore from "@pulumi/gcore";

const pr = gcore.getProject({
    name: "test",
});
const rg = gcore.getRegion({
    name: "ED-10 Preprod",
});
const ubuntu = Promise.all([rg, pr]).then(([rg, pr]) => gcore.getImage({
    name: "ubuntu-22.04-x64",
    regionId: rg.id,
    projectId: pr.id,
}));
export const view = ubuntu;
Copy
import pulumi
import pulumi_gcore as gcore

pr = gcore.get_project(name="test")
rg = gcore.get_region(name="ED-10 Preprod")
ubuntu = gcore.get_image(name="ubuntu-22.04-x64",
    region_id=rg.id,
    project_id=pr.id)
pulumi.export("view", ubuntu)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/gcore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pr, err := gcore.GetProject(ctx, &gcore.GetProjectArgs{
			Name: "test",
		}, nil)
		if err != nil {
			return err
		}
		rg, err := gcore.GetRegion(ctx, &gcore.GetRegionArgs{
			Name: "ED-10 Preprod",
		}, nil)
		if err != nil {
			return err
		}
		ubuntu, err := gcore.GetImage(ctx, &gcore.GetImageArgs{
			Name:      pulumi.StringRef("ubuntu-22.04-x64"),
			RegionId:  pulumi.Float64Ref(rg.Id),
			ProjectId: pulumi.Float64Ref(pr.Id),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("view", ubuntu)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcore = Pulumi.Gcore;

return await Deployment.RunAsync(() => 
{
    var pr = Gcore.GetProject.Invoke(new()
    {
        Name = "test",
    });

    var rg = Gcore.GetRegion.Invoke(new()
    {
        Name = "ED-10 Preprod",
    });

    var ubuntu = Gcore.GetImage.Invoke(new()
    {
        Name = "ubuntu-22.04-x64",
        RegionId = rg.Apply(getRegionResult => getRegionResult.Id),
        ProjectId = pr.Apply(getProjectResult => getProjectResult.Id),
    });

    return new Dictionary<string, object?>
    {
        ["view"] = ubuntu,
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcore.GcoreFunctions;
import com.pulumi.gcore.inputs.GetProjectArgs;
import com.pulumi.gcore.inputs.GetRegionArgs;
import com.pulumi.gcore.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) {
        final var pr = GcoreFunctions.getProject(GetProjectArgs.builder()
            .name("test")
            .build());

        final var rg = GcoreFunctions.getRegion(GetRegionArgs.builder()
            .name("ED-10 Preprod")
            .build());

        final var ubuntu = GcoreFunctions.getImage(GetImageArgs.builder()
            .name("ubuntu-22.04-x64")
            .regionId(rg.applyValue(getRegionResult -> getRegionResult.id()))
            .projectId(pr.applyValue(getProjectResult -> getProjectResult.id()))
            .build());

        ctx.export("view", ubuntu.applyValue(getImageResult -> getImageResult));
    }
}
Copy
variables:
  pr:
    fn::invoke:
      function: gcore:getProject
      arguments:
        name: test
  rg:
    fn::invoke:
      function: gcore:getRegion
      arguments:
        name: ED-10 Preprod
  ubuntu:
    fn::invoke:
      function: gcore:getImage
      arguments:
        name: ubuntu-22.04-x64
        regionId: ${rg.id}
        projectId: ${pr.id}
outputs:
  view: ${ubuntu}
Copy

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>
Copy
def get_image(id: Optional[str] = None,
              image_id: Optional[str] = None,
              is_baremetal: Optional[bool] = None,
              metadata_k: Optional[str] = None,
              metadata_kv: Optional[Mapping[str, str]] = None,
              name: Optional[str] = None,
              project_id: Optional[float] = None,
              project_name: Optional[str] = None,
              region_id: Optional[float] = None,
              region_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetImageResult
def get_image_output(id: Optional[pulumi.Input[str]] = None,
              image_id: Optional[pulumi.Input[str]] = None,
              is_baremetal: Optional[pulumi.Input[bool]] = None,
              metadata_k: Optional[pulumi.Input[str]] = None,
              metadata_kv: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
              name: Optional[pulumi.Input[str]] = None,
              project_id: Optional[pulumi.Input[float]] = None,
              project_name: Optional[pulumi.Input[str]] = None,
              region_id: Optional[pulumi.Input[float]] = None,
              region_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetImageResult]
Copy
func GetImage(ctx *Context, args *GetImageArgs, opts ...InvokeOption) (*GetImageResult, error)
func GetImageOutput(ctx *Context, args *GetImageOutputArgs, opts ...InvokeOption) GetImageResultOutput
Copy

> Note: This function is named GetImage 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)
}
Copy
public static CompletableFuture<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
public static Output<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: gcore:index/getImage:getImage
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
The ID of this resource.
ImageId string
use 'image_id' if you know it, for example 'f4b1b1b1-1b1b-1b1b-1b1b-1b1b1b1b1b1b'
IsBaremetal bool
set to true if you need to get baremetal image
MetadataK string
MetadataKv Dictionary<string, string>
Name string
use 'os-version', for example 'ubuntu-20.04'
ProjectId double
ProjectName string
RegionId double
RegionName string
Id string
The ID of this resource.
ImageId string
use 'image_id' if you know it, for example 'f4b1b1b1-1b1b-1b1b-1b1b-1b1b1b1b1b1b'
IsBaremetal bool
set to true if you need to get baremetal image
MetadataK string
MetadataKv map[string]string
Name string
use 'os-version', for example 'ubuntu-20.04'
ProjectId float64
ProjectName string
RegionId float64
RegionName string
id String
The ID of this resource.
imageId String
use 'image_id' if you know it, for example 'f4b1b1b1-1b1b-1b1b-1b1b-1b1b1b1b1b1b'
isBaremetal Boolean
set to true if you need to get baremetal image
metadataK String
metadataKv Map<String,String>
name String
use 'os-version', for example 'ubuntu-20.04'
projectId Double
projectName String
regionId Double
regionName String
id string
The ID of this resource.
imageId string
use 'image_id' if you know it, for example 'f4b1b1b1-1b1b-1b1b-1b1b-1b1b1b1b1b1b'
isBaremetal boolean
set to true if you need to get baremetal image
metadataK string
metadataKv {[key: string]: string}
name string
use 'os-version', for example 'ubuntu-20.04'
projectId number
projectName string
regionId number
regionName string
id str
The ID of this resource.
image_id str
use 'image_id' if you know it, for example 'f4b1b1b1-1b1b-1b1b-1b1b-1b1b1b1b1b1b'
is_baremetal bool
set to true if you need to get baremetal image
metadata_k str
metadata_kv Mapping[str, str]
name str
use 'os-version', for example 'ubuntu-20.04'
project_id float
project_name str
region_id float
region_name str
id String
The ID of this resource.
imageId String
use 'image_id' if you know it, for example 'f4b1b1b1-1b1b-1b1b-1b1b-1b1b1b1b1b1b'
isBaremetal Boolean
set to true if you need to get baremetal image
metadataK String
metadataKv Map<String>
name String
use 'os-version', for example 'ubuntu-20.04'
projectId Number
projectName String
regionId Number
regionName String

getImage Result

The following output properties are available:

Description string
Id string
The ID of this resource.
MetadataReadOnlies List<GetImageMetadataReadOnly>
MinDisk double
MinRam double
OsDistro string
OsVersion string
ImageId string
use 'image_id' if you know it, for example 'f4b1b1b1-1b1b-1b1b-1b1b-1b1b1b1b1b1b'
IsBaremetal bool
set to true if you need to get baremetal image
MetadataK string
MetadataKv Dictionary<string, string>
Name string
use 'os-version', for example 'ubuntu-20.04'
ProjectId double
ProjectName string
RegionId double
RegionName string
Description string
Id string
The ID of this resource.
MetadataReadOnlies []GetImageMetadataReadOnly
MinDisk float64
MinRam float64
OsDistro string
OsVersion string
ImageId string
use 'image_id' if you know it, for example 'f4b1b1b1-1b1b-1b1b-1b1b-1b1b1b1b1b1b'
IsBaremetal bool
set to true if you need to get baremetal image
MetadataK string
MetadataKv map[string]string
Name string
use 'os-version', for example 'ubuntu-20.04'
ProjectId float64
ProjectName string
RegionId float64
RegionName string
description String
id String
The ID of this resource.
metadataReadOnlies List<GetImageMetadataReadOnly>
minDisk Double
minRam Double
osDistro String
osVersion String
imageId String
use 'image_id' if you know it, for example 'f4b1b1b1-1b1b-1b1b-1b1b-1b1b1b1b1b1b'
isBaremetal Boolean
set to true if you need to get baremetal image
metadataK String
metadataKv Map<String,String>
name String
use 'os-version', for example 'ubuntu-20.04'
projectId Double
projectName String
regionId Double
regionName String
description string
id string
The ID of this resource.
metadataReadOnlies GetImageMetadataReadOnly[]
minDisk number
minRam number
osDistro string
osVersion string
imageId string
use 'image_id' if you know it, for example 'f4b1b1b1-1b1b-1b1b-1b1b-1b1b1b1b1b1b'
isBaremetal boolean
set to true if you need to get baremetal image
metadataK string
metadataKv {[key: string]: string}
name string
use 'os-version', for example 'ubuntu-20.04'
projectId number
projectName string
regionId number
regionName string
description str
id str
The ID of this resource.
metadata_read_onlies Sequence[GetImageMetadataReadOnly]
min_disk float
min_ram float
os_distro str
os_version str
image_id str
use 'image_id' if you know it, for example 'f4b1b1b1-1b1b-1b1b-1b1b-1b1b1b1b1b1b'
is_baremetal bool
set to true if you need to get baremetal image
metadata_k str
metadata_kv Mapping[str, str]
name str
use 'os-version', for example 'ubuntu-20.04'
project_id float
project_name str
region_id float
region_name str
description String
id String
The ID of this resource.
metadataReadOnlies List<Property Map>
minDisk Number
minRam Number
osDistro String
osVersion String
imageId String
use 'image_id' if you know it, for example 'f4b1b1b1-1b1b-1b1b-1b1b-1b1b1b1b1b1b'
isBaremetal Boolean
set to true if you need to get baremetal image
metadataK String
metadataKv Map<String>
name String
use 'os-version', for example 'ubuntu-20.04'
projectId Number
projectName String
regionId Number
regionName String

Supporting Types

GetImageMetadataReadOnly

Key This property is required. string
ReadOnly This property is required. bool
Value This property is required. string
Key This property is required. string
ReadOnly This property is required. bool
Value This property is required. string
key This property is required. String
readOnly This property is required. Boolean
value This property is required. String
key This property is required. string
readOnly This property is required. boolean
value This property is required. string
key This property is required. str
read_only This property is required. bool
value This property is required. str
key This property is required. String
readOnly This property is required. Boolean
value This property is required. String

Package Details

Repository
gcore g-core/terraform-provider-gcore
License
Notes
This Pulumi package is based on the gcore Terraform Provider.
gcore 0.19.0 published on Monday, Apr 14, 2025 by g-core
g-core/terraform-provider-gcore