Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vkcs Provider
  3. API Docs
  4. getImagesImages
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs

vkcs.getImagesImages

Explore with Pulumi AI

vkcs logo
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs

    Use this data source to get information on VKCS images.

    New since v0.4.2.

    Example Usage

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

const images = vkcs.getImagesImages({
    "default": true,
    properties: {
        mcs_os_distro: "debian",
    },
    visibility: "public",
});

    import pulumi
import pulumi_vkcs as vkcs

images = vkcs.get_images_images(default=True,
    properties={
        "mcs_os_distro": "debian",
    },
    visibility="public")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.GetImagesImages(ctx, &vkcs.GetImagesImagesArgs{
			Default: pulumi.BoolRef(true),
			Properties: map[string]interface{}{
				"mcs_os_distro": "debian",
			},
			Visibility: pulumi.StringRef("public"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var images = Vkcs.GetImagesImages.Invoke(new()
    {
        Default = true,
        Properties = 
        {
            { "mcs_os_distro", "debian" },
        },
        Visibility = "public",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.VkcsFunctions;
import com.pulumi.vkcs.inputs.GetImagesImagesArgs;
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 = VkcsFunctions.getImagesImages(GetImagesImagesArgs.builder()
            .default_(true)
            .properties(Map.of("mcs_os_distro", "debian"))
            .visibility("public")
            .build());

    }
}

    variables:
  images:
    fn::invoke:
      function: vkcs:getImagesImages
      arguments:
        default: true
        properties:
          mcs_os_distro: debian
        visibility: public

    Using getImagesImages

    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 getImagesImages(args: GetImagesImagesArgs, opts?: InvokeOptions): Promise<GetImagesImagesResult>
function getImagesImagesOutput(args: GetImagesImagesOutputArgs, opts?: InvokeOptions): Output<GetImagesImagesResult>
    def get_images_images(created_at: Optional[str] = None,
                      default: Optional[bool] = None,
                      owner: Optional[str] = None,
                      properties: Optional[Mapping[str, str]] = None,
                      region: Optional[str] = None,
                      size_max: Optional[float] = None,
                      size_min: Optional[float] = None,
                      tags: Optional[Sequence[str]] = None,
                      updated_at: Optional[str] = None,
                      visibility: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetImagesImagesResult
def get_images_images_output(created_at: Optional[pulumi.Input[str]] = None,
                      default: Optional[pulumi.Input[bool]] = None,
                      owner: Optional[pulumi.Input[str]] = None,
                      properties: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                      region: Optional[pulumi.Input[str]] = None,
                      size_max: Optional[pulumi.Input[float]] = None,
                      size_min: Optional[pulumi.Input[float]] = None,
                      tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      updated_at: Optional[pulumi.Input[str]] = None,
                      visibility: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetImagesImagesResult]
    func GetImagesImages(ctx *Context, args *GetImagesImagesArgs, opts ...InvokeOption) (*GetImagesImagesResult, error)
func GetImagesImagesOutput(ctx *Context, args *GetImagesImagesOutputArgs, opts ...InvokeOption) GetImagesImagesResultOutput

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

    public static class GetImagesImages 
{
    public static Task<GetImagesImagesResult> InvokeAsync(GetImagesImagesArgs args, InvokeOptions? opts = null)
    public static Output<GetImagesImagesResult> Invoke(GetImagesImagesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetImagesImagesResult> getImagesImages(GetImagesImagesArgs args, InvokeOptions options)
public static Output<GetImagesImagesResult> getImagesImages(GetImagesImagesArgs args, InvokeOptions options)

    fn::invoke:
  function: vkcs:index/getImagesImages:getImagesImages
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CreatedAt string
    optional string → Date filter to select images with created_at matching the specified criteria. Value should be either RFC3339 formatted time or time filter in format filter:time, where filter is one of [eq, neq, gt, gte, lt, lte] and time is RFC3339 formatted time.
    Default bool
    optional boolean → The flag used to filter images based on whether they are available for virtual machine creation.
    Owner string
    optional string → The ID of the owner of images.
    Properties Dictionary<string, string>
    optional map of string → Search for images with specific properties.
    Region string
    optional string → The region in which to obtain the Images client. If omitted, the region argument of the provider is used.
    SizeMax double
    optional number → The maximum size (in bytes) of images to return.
    SizeMin double
    optional number → The minimum size (in bytes) of images to return.
    Tags List<string>
    optional string → Search for images with specific tags.
    UpdatedAt string
    optional string → Date filter to select images with updated_at matching the specified criteria. Value should be either RFC3339 formatted time or time filter in format filter:time, where filter is one of [eq, neq, gt, gte, lt, lte] and time is RFC3339 formatted time.
    Visibility string
    optional string → The visibility of images. Must be one of "public", "private", "community", or "shared".
    CreatedAt string
    optional string → Date filter to select images with created_at matching the specified criteria. Value should be either RFC3339 formatted time or time filter in format filter:time, where filter is one of [eq, neq, gt, gte, lt, lte] and time is RFC3339 formatted time.
    Default bool
    optional boolean → The flag used to filter images based on whether they are available for virtual machine creation.
    Owner string
    optional string → The ID of the owner of images.
    Properties map[string]string
    optional map of string → Search for images with specific properties.
    Region string
    optional string → The region in which to obtain the Images client. If omitted, the region argument of the provider is used.
    SizeMax float64
    optional number → The maximum size (in bytes) of images to return.
    SizeMin float64
    optional number → The minimum size (in bytes) of images to return.
    Tags []string
    optional string → Search for images with specific tags.
    UpdatedAt string
    optional string → Date filter to select images with updated_at matching the specified criteria. Value should be either RFC3339 formatted time or time filter in format filter:time, where filter is one of [eq, neq, gt, gte, lt, lte] and time is RFC3339 formatted time.
    Visibility string
    optional string → The visibility of images. Must be one of "public", "private", "community", or "shared".
    createdAt String
    optional string → Date filter to select images with created_at matching the specified criteria. Value should be either RFC3339 formatted time or time filter in format filter:time, where filter is one of [eq, neq, gt, gte, lt, lte] and time is RFC3339 formatted time.
    default_ Boolean
    optional boolean → The flag used to filter images based on whether they are available for virtual machine creation.
    owner String
    optional string → The ID of the owner of images.
    properties Map<String,String>
    optional map of string → Search for images with specific properties.
    region String
    optional string → The region in which to obtain the Images client. If omitted, the region argument of the provider is used.
    sizeMax Double
    optional number → The maximum size (in bytes) of images to return.
    sizeMin Double
    optional number → The minimum size (in bytes) of images to return.
    tags List<String>
    optional string → Search for images with specific tags.
    updatedAt String
    optional string → Date filter to select images with updated_at matching the specified criteria. Value should be either RFC3339 formatted time or time filter in format filter:time, where filter is one of [eq, neq, gt, gte, lt, lte] and time is RFC3339 formatted time.
    visibility String
    optional string → The visibility of images. Must be one of "public", "private", "community", or "shared".
    createdAt string
    optional string → Date filter to select images with created_at matching the specified criteria. Value should be either RFC3339 formatted time or time filter in format filter:time, where filter is one of [eq, neq, gt, gte, lt, lte] and time is RFC3339 formatted time.
    default boolean
    optional boolean → The flag used to filter images based on whether they are available for virtual machine creation.
    owner string
    optional string → The ID of the owner of images.
    properties {[key: string]: string}
    optional map of string → Search for images with specific properties.
    region string
    optional string → The region in which to obtain the Images client. If omitted, the region argument of the provider is used.
    sizeMax number
    optional number → The maximum size (in bytes) of images to return.
    sizeMin number
    optional number → The minimum size (in bytes) of images to return.
    tags string[]
    optional string → Search for images with specific tags.
    updatedAt string
    optional string → Date filter to select images with updated_at matching the specified criteria. Value should be either RFC3339 formatted time or time filter in format filter:time, where filter is one of [eq, neq, gt, gte, lt, lte] and time is RFC3339 formatted time.
    visibility string
    optional string → The visibility of images. Must be one of "public", "private", "community", or "shared".
    created_at str
    optional string → Date filter to select images with created_at matching the specified criteria. Value should be either RFC3339 formatted time or time filter in format filter:time, where filter is one of [eq, neq, gt, gte, lt, lte] and time is RFC3339 formatted time.
    default bool
    optional boolean → The flag used to filter images based on whether they are available for virtual machine creation.
    owner str
    optional string → The ID of the owner of images.
    properties Mapping[str, str]
    optional map of string → Search for images with specific properties.
    region str
    optional string → The region in which to obtain the Images client. If omitted, the region argument of the provider is used.
    size_max float
    optional number → The maximum size (in bytes) of images to return.
    size_min float
    optional number → The minimum size (in bytes) of images to return.
    tags Sequence[str]
    optional string → Search for images with specific tags.
    updated_at str
    optional string → Date filter to select images with updated_at matching the specified criteria. Value should be either RFC3339 formatted time or time filter in format filter:time, where filter is one of [eq, neq, gt, gte, lt, lte] and time is RFC3339 formatted time.
    visibility str
    optional string → The visibility of images. Must be one of "public", "private", "community", or "shared".
    createdAt String
    optional string → Date filter to select images with created_at matching the specified criteria. Value should be either RFC3339 formatted time or time filter in format filter:time, where filter is one of [eq, neq, gt, gte, lt, lte] and time is RFC3339 formatted time.
    default Boolean
    optional boolean → The flag used to filter images based on whether they are available for virtual machine creation.
    owner String
    optional string → The ID of the owner of images.
    properties Map<String>
    optional map of string → Search for images with specific properties.
    region String
    optional string → The region in which to obtain the Images client. If omitted, the region argument of the provider is used.
    sizeMax Number
    optional number → The maximum size (in bytes) of images to return.
    sizeMin Number
    optional number → The minimum size (in bytes) of images to return.
    tags List<String>
    optional string → Search for images with specific tags.
    updatedAt String
    optional string → Date filter to select images with updated_at matching the specified criteria. Value should be either RFC3339 formatted time or time filter in format filter:time, where filter is one of [eq, neq, gt, gte, lt, lte] and time is RFC3339 formatted time.
    visibility String
    optional string → The visibility of images. Must be one of "public", "private", "community", or "shared".

    getImagesImages Result

    The following output properties are available:

    Id string
    string → ID of an image.
    Images List<GetImagesImagesImage>
    list → Images matching specified criteria.
    Region string
    CreatedAt string
    Default bool
    Owner string
    Properties Dictionary<string, string>
    map of string → Properties associated with an image.
    SizeMax double
    SizeMin double
    Tags List<string>
    UpdatedAt string
    Visibility string
    Id string
    string → ID of an image.
    Images []GetImagesImagesImage
    list → Images matching specified criteria.
    Region string
    CreatedAt string
    Default bool
    Owner string
    Properties map[string]string
    map of string → Properties associated with an image.
    SizeMax float64
    SizeMin float64
    Tags []string
    UpdatedAt string
    Visibility string
    id String
    string → ID of an image.
    images List<GetImagesImagesImage>
    list → Images matching specified criteria.
    region String
    createdAt String
    default_ Boolean
    owner String
    properties Map<String,String>
    map of string → Properties associated with an image.
    sizeMax Double
    sizeMin Double
    tags List<String>
    updatedAt String
    visibility String
    id string
    string → ID of an image.
    images GetImagesImagesImage[]
    list → Images matching specified criteria.
    region string
    createdAt string
    default boolean
    owner string
    properties {[key: string]: string}
    map of string → Properties associated with an image.
    sizeMax number
    sizeMin number
    tags string[]
    updatedAt string
    visibility string
    id str
    string → ID of an image.
    images Sequence[GetImagesImagesImage]
    list → Images matching specified criteria.
    region str
    created_at str
    default bool
    owner str
    properties Mapping[str, str]
    map of string → Properties associated with an image.
    size_max float
    size_min float
    tags Sequence[str]
    updated_at str
    visibility str
    id String
    string → ID of an image.
    images List<Property Map>
    list → Images matching specified criteria.
    region String
    createdAt String
    default Boolean
    owner String
    properties Map<String>
    map of string → Properties associated with an image.
    sizeMax Number
    sizeMin Number
    tags List<String>
    updatedAt String
    visibility String

    Supporting Types

    GetImagesImagesImage

    Id string
    string → ID of an image.
    Name string
    string → Name of an image.
    Properties Dictionary<string, string>
    optional map of string → Search for images with specific properties.
    Id string
    string → ID of an image.
    Name string
    string → Name of an image.
    Properties map[string]string
    optional map of string → Search for images with specific properties.
    id String
    string → ID of an image.
    name String
    string → Name of an image.
    properties Map<String,String>
    optional map of string → Search for images with specific properties.
    id string
    string → ID of an image.
    name string
    string → Name of an image.
    properties {[key: string]: string}
    optional map of string → Search for images with specific properties.
    id str
    string → ID of an image.
    name str
    string → Name of an image.
    properties Mapping[str, str]
    optional map of string → Search for images with specific properties.
    id String
    string → ID of an image.
    name String
    string → Name of an image.
    properties Map<String>
    optional map of string → Search for images with specific properties.

    Package Details

    Repository
    vkcs vk-cs/terraform-provider-vkcs
    License
    Notes
    This Pulumi package is based on the vkcs Terraform Provider.
    vkcs logo
    vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
    vk-cs/terraform-provider-vkcs