1. Packages
  2. OVH
  3. API Docs
  4. CloudProject
  5. getImages
OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud

ovh.CloudProject.getImages

Explore with Pulumi AI

OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud

Get available images in the given public cloud project.

Example Usage

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

const images = ovh.CloudProject.getImages({
    osType: "linux",
    region: "WAW1",
    serviceName: "<public cloud project ID>",
});
Copy
import pulumi
import pulumi_ovh as ovh

images = ovh.CloudProject.get_images(os_type="linux",
    region="WAW1",
    service_name="<public cloud project ID>")
Copy
package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh/cloudproject"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudproject.GetImages(ctx, &cloudproject.GetImagesArgs{
			OsType:      pulumi.StringRef("linux"),
			Region:      pulumi.StringRef("WAW1"),
			ServiceName: "<public cloud project ID>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;

return await Deployment.RunAsync(() => 
{
    var images = Ovh.CloudProject.GetImages.Invoke(new()
    {
        OsType = "linux",
        Region = "WAW1",
        ServiceName = "<public cloud project ID>",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.CloudProject.CloudProjectFunctions;
import com.pulumi.ovh.CloudProject.inputs.GetImagesArgs;
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 images = CloudProjectFunctions.getImages(GetImagesArgs.builder()
            .osType("linux")
            .region("WAW1")
            .serviceName("<public cloud project ID>")
            .build());

    }
}
Copy
variables:
  images:
    fn::invoke:
      function: ovh:CloudProject:getImages
      arguments:
        osType: linux
        region: WAW1
        serviceName: <public cloud project ID>
Copy

Using getImages

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 getImages(args: GetImagesArgs, opts?: InvokeOptions): Promise<GetImagesResult>
function getImagesOutput(args: GetImagesOutputArgs, opts?: InvokeOptions): Output<GetImagesResult>
Copy
def get_images(flavor_type: Optional[str] = None,
               os_type: Optional[str] = None,
               region: Optional[str] = None,
               service_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetImagesResult
def get_images_output(flavor_type: Optional[pulumi.Input[str]] = None,
               os_type: Optional[pulumi.Input[str]] = None,
               region: Optional[pulumi.Input[str]] = None,
               service_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetImagesResult]
Copy
func GetImages(ctx *Context, args *GetImagesArgs, opts ...InvokeOption) (*GetImagesResult, error)
func GetImagesOutput(ctx *Context, args *GetImagesOutputArgs, opts ...InvokeOption) GetImagesResultOutput
Copy

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

public static class GetImages 
{
    public static Task<GetImagesResult> InvokeAsync(GetImagesArgs args, InvokeOptions? opts = null)
    public static Output<GetImagesResult> Invoke(GetImagesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetImagesResult> getImages(GetImagesArgs args, InvokeOptions options)
public static Output<GetImagesResult> getImages(GetImagesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ovh:CloudProject/getImages:getImages
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ServiceName This property is required. string
Public cloud project ID
FlavorType string
Get compatible images with flavor type
OsType string
Image OS (Allowed values: baremetal-linux ┃ bsd ┃ linux ┃ windows)
Region string
Image region
ServiceName This property is required. string
Public cloud project ID
FlavorType string
Get compatible images with flavor type
OsType string
Image OS (Allowed values: baremetal-linux ┃ bsd ┃ linux ┃ windows)
Region string
Image region
serviceName This property is required. String
Public cloud project ID
flavorType String
Get compatible images with flavor type
osType String
Image OS (Allowed values: baremetal-linux ┃ bsd ┃ linux ┃ windows)
region String
Image region
serviceName This property is required. string
Public cloud project ID
flavorType string
Get compatible images with flavor type
osType string
Image OS (Allowed values: baremetal-linux ┃ bsd ┃ linux ┃ windows)
region string
Image region
service_name This property is required. str
Public cloud project ID
flavor_type str
Get compatible images with flavor type
os_type str
Image OS (Allowed values: baremetal-linux ┃ bsd ┃ linux ┃ windows)
region str
Image region
serviceName This property is required. String
Public cloud project ID
flavorType String
Get compatible images with flavor type
osType String
Image OS (Allowed values: baremetal-linux ┃ bsd ┃ linux ┃ windows)
region String
Image region

getImages Result

The following output properties are available:

FlavorType string
Get compatible images with flavor type
Id string
The provider-assigned unique ID for this managed resource.
Images List<GetImagesImage>
OsType string
Image OS (Allowed values: baremetal-linux ┃ bsd ┃ linux ┃ windows)
Region string
Image region
ServiceName string
Public cloud project ID
FlavorType string
Get compatible images with flavor type
Id string
The provider-assigned unique ID for this managed resource.
Images []GetImagesImage
OsType string
Image OS (Allowed values: baremetal-linux ┃ bsd ┃ linux ┃ windows)
Region string
Image region
ServiceName string
Public cloud project ID
flavorType String
Get compatible images with flavor type
id String
The provider-assigned unique ID for this managed resource.
images List<GetImagesImage>
osType String
Image OS (Allowed values: baremetal-linux ┃ bsd ┃ linux ┃ windows)
region String
Image region
serviceName String
Public cloud project ID
flavorType string
Get compatible images with flavor type
id string
The provider-assigned unique ID for this managed resource.
images GetImagesImage[]
osType string
Image OS (Allowed values: baremetal-linux ┃ bsd ┃ linux ┃ windows)
region string
Image region
serviceName string
Public cloud project ID
flavor_type str
Get compatible images with flavor type
id str
The provider-assigned unique ID for this managed resource.
images Sequence[cloudproject.GetImagesImage]
os_type str
Image OS (Allowed values: baremetal-linux ┃ bsd ┃ linux ┃ windows)
region str
Image region
service_name str
Public cloud project ID
flavorType String
Get compatible images with flavor type
id String
The provider-assigned unique ID for this managed resource.
images List<Property Map>
osType String
Image OS (Allowed values: baremetal-linux ┃ bsd ┃ linux ┃ windows)
region String
Image region
serviceName String
Public cloud project ID

Supporting Types

GetImagesImage

CreationDate This property is required. string
Image creation date
FlavorType This property is required. string
Image usable only for this type of flavor if not null
Id This property is required. string
Image ID
MinDisk This property is required. double
Minimum disks required to use image
MinRam This property is required. double
Minimum RAM required to use image
Name This property is required. string
Image name
PlanCode This property is required. string
Order plan code
Region This property is required. string
Image region
Size This property is required. double
Image size (in GiB)
Status This property is required. string
Image status
Tags This property is required. List<string>
Tags about the image
Type This property is required. string
Image type
User This property is required. string
User to connect with
Visibility This property is required. string
Image visibility
CreationDate This property is required. string
Image creation date
FlavorType This property is required. string
Image usable only for this type of flavor if not null
Id This property is required. string
Image ID
MinDisk This property is required. float64
Minimum disks required to use image
MinRam This property is required. float64
Minimum RAM required to use image
Name This property is required. string
Image name
PlanCode This property is required. string
Order plan code
Region This property is required. string
Image region
Size This property is required. float64
Image size (in GiB)
Status This property is required. string
Image status
Tags This property is required. []string
Tags about the image
Type This property is required. string
Image type
User This property is required. string
User to connect with
Visibility This property is required. string
Image visibility
creationDate This property is required. String
Image creation date
flavorType This property is required. String
Image usable only for this type of flavor if not null
id This property is required. String
Image ID
minDisk This property is required. Double
Minimum disks required to use image
minRam This property is required. Double
Minimum RAM required to use image
name This property is required. String
Image name
planCode This property is required. String
Order plan code
region This property is required. String
Image region
size This property is required. Double
Image size (in GiB)
status This property is required. String
Image status
tags This property is required. List<String>
Tags about the image
type This property is required. String
Image type
user This property is required. String
User to connect with
visibility This property is required. String
Image visibility
creationDate This property is required. string
Image creation date
flavorType This property is required. string
Image usable only for this type of flavor if not null
id This property is required. string
Image ID
minDisk This property is required. number
Minimum disks required to use image
minRam This property is required. number
Minimum RAM required to use image
name This property is required. string
Image name
planCode This property is required. string
Order plan code
region This property is required. string
Image region
size This property is required. number
Image size (in GiB)
status This property is required. string
Image status
tags This property is required. string[]
Tags about the image
type This property is required. string
Image type
user This property is required. string
User to connect with
visibility This property is required. string
Image visibility
creation_date This property is required. str
Image creation date
flavor_type This property is required. str
Image usable only for this type of flavor if not null
id This property is required. str
Image ID
min_disk This property is required. float
Minimum disks required to use image
min_ram This property is required. float
Minimum RAM required to use image
name This property is required. str
Image name
plan_code This property is required. str
Order plan code
region This property is required. str
Image region
size This property is required. float
Image size (in GiB)
status This property is required. str
Image status
tags This property is required. Sequence[str]
Tags about the image
type This property is required. str
Image type
user This property is required. str
User to connect with
visibility This property is required. str
Image visibility
creationDate This property is required. String
Image creation date
flavorType This property is required. String
Image usable only for this type of flavor if not null
id This property is required. String
Image ID
minDisk This property is required. Number
Minimum disks required to use image
minRam This property is required. Number
Minimum RAM required to use image
name This property is required. String
Image name
planCode This property is required. String
Order plan code
region This property is required. String
Image region
size This property is required. Number
Image size (in GiB)
status This property is required. String
Image status
tags This property is required. List<String>
Tags about the image
type This property is required. String
Image type
user This property is required. String
User to connect with
visibility This property is required. String
Image visibility

Package Details

Repository
ovh ovh/pulumi-ovh
License
Apache-2.0
Notes
This Pulumi package is based on the ovh Terraform Provider.
OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud