1. Packages
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. getIsImages
Viewing docs for ibm 2.1.0
published on Tuesday, May 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.getIsImages

Viewing docs for ibm 2.1.0
published on Tuesday, May 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Retrieve information of an existing IBM Cloud Infrastructure images as a read-only data source. For more information, about IBM Cloud infrastructure images, see Images.

    Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

    provider.tf

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

    import pulumi

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}

    {}

    Example Usage

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

const dsImages = ibm.getIsImages({});

    import pulumi
import pulumi_ibm as ibm

ds_images = ibm.get_is_images()

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetIsImages(ctx, &ibm.GetIsImagesArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var dsImages = Ibm.GetIsImages.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIsImagesArgs;
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 dsImages = IbmFunctions.getIsImages(GetIsImagesArgs.builder()
            .build());

    }
}

    variables:
  dsImages:
    fn::invoke:
      function: ibm:getIsImages
      arguments: {}

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

const dsImages = ibm.getIsImages({
    visibility: "public",
});

    import pulumi
import pulumi_ibm as ibm

ds_images = ibm.get_is_images(visibility="public")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetIsImages(ctx, &ibm.GetIsImagesArgs{
			Visibility: pulumi.StringRef("public"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var dsImages = Ibm.GetIsImages.Invoke(new()
    {
        Visibility = "public",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIsImagesArgs;
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 dsImages = IbmFunctions.getIsImages(GetIsImagesArgs.builder()
            .visibility("public")
            .build());

    }
}

    variables:
  dsImages:
    fn::invoke:
      function: ibm:getIsImages
      arguments:
        visibility: public

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

const remoteImages = ibm.getIsImages({
    remoteAccountId: "provider",
});

    import pulumi
import pulumi_ibm as ibm

remote_images = ibm.get_is_images(remote_account_id="provider")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetIsImages(ctx, &ibm.GetIsImagesArgs{
			RemoteAccountId: pulumi.StringRef("provider"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var remoteImages = Ibm.GetIsImages.Invoke(new()
    {
        RemoteAccountId = "provider",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIsImagesArgs;
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 remoteImages = IbmFunctions.getIsImages(GetIsImagesArgs.builder()
            .remoteAccountId("provider")
            .build());

    }
}

    variables:
  remoteImages:
    fn::invoke:
      function: ibm:getIsImages
      arguments:
        remoteAccountId: provider

    Using getIsImages

    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 getIsImages(args: GetIsImagesArgs, opts?: InvokeOptions): Promise<GetIsImagesResult>
function getIsImagesOutput(args: GetIsImagesOutputArgs, opts?: InvokeOptions): Output<GetIsImagesResult>
    def get_is_images(catalog_managed: Optional[bool] = None,
                  id: Optional[str] = None,
                  name: Optional[str] = None,
                  remote_account_id: Optional[str] = None,
                  resource_group: Optional[str] = None,
                  status: Optional[str] = None,
                  user_data_formats: Optional[Sequence[str]] = None,
                  visibility: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetIsImagesResult
def get_is_images_output(catalog_managed: pulumi.Input[Optional[bool]] = None,
                  id: pulumi.Input[Optional[str]] = None,
                  name: pulumi.Input[Optional[str]] = None,
                  remote_account_id: pulumi.Input[Optional[str]] = None,
                  resource_group: pulumi.Input[Optional[str]] = None,
                  status: pulumi.Input[Optional[str]] = None,
                  user_data_formats: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
                  visibility: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetIsImagesResult]
    func GetIsImages(ctx *Context, args *GetIsImagesArgs, opts ...InvokeOption) (*GetIsImagesResult, error)
func GetIsImagesOutput(ctx *Context, args *GetIsImagesOutputArgs, opts ...InvokeOption) GetIsImagesResultOutput

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

    public static class GetIsImages 
{
    public static Task<GetIsImagesResult> InvokeAsync(GetIsImagesArgs args, InvokeOptions? opts = null)
    public static Output<GetIsImagesResult> Invoke(GetIsImagesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsImagesResult> getIsImages(GetIsImagesArgs args, InvokeOptions options)
public static Output<GetIsImagesResult> getIsImages(GetIsImagesArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getIsImages:getIsImages
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CatalogManaged bool
    Lists only those images which are managed as part of a catalog offering.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    The name of the image.
    RemoteAccountId string
    Filters the collection to images with a remote account id matching the specified value. Accepted values are provider, user, or a valid account ID.
    ResourceGroup string
    The id of the resource group.
    Status string
    Status of the image. Accepted values: available, deleting, deprecated, failed, obsolete, pending, tentative, unusable
    UserDataFormats List<string>

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    Visibility string
    Visibility of the image. Accepted values: private, public
    CatalogManaged bool
    Lists only those images which are managed as part of a catalog offering.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    The name of the image.
    RemoteAccountId string
    Filters the collection to images with a remote account id matching the specified value. Accepted values are provider, user, or a valid account ID.
    ResourceGroup string
    The id of the resource group.
    Status string
    Status of the image. Accepted values: available, deleting, deprecated, failed, obsolete, pending, tentative, unusable
    UserDataFormats []string

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    Visibility string
    Visibility of the image. Accepted values: private, public
    catalogManaged Boolean
    Lists only those images which are managed as part of a catalog offering.
    id String
    (String) The unique identifier for this resource group.
    name String
    The name of the image.
    remoteAccountId String
    Filters the collection to images with a remote account id matching the specified value. Accepted values are provider, user, or a valid account ID.
    resourceGroup String
    The id of the resource group.
    status String
    Status of the image. Accepted values: available, deleting, deprecated, failed, obsolete, pending, tentative, unusable
    userDataFormats List<String>

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    visibility String
    Visibility of the image. Accepted values: private, public
    catalogManaged boolean
    Lists only those images which are managed as part of a catalog offering.
    id string
    (String) The unique identifier for this resource group.
    name string
    The name of the image.
    remoteAccountId string
    Filters the collection to images with a remote account id matching the specified value. Accepted values are provider, user, or a valid account ID.
    resourceGroup string
    The id of the resource group.
    status string
    Status of the image. Accepted values: available, deleting, deprecated, failed, obsolete, pending, tentative, unusable
    userDataFormats string[]

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    visibility string
    Visibility of the image. Accepted values: private, public
    catalog_managed bool
    Lists only those images which are managed as part of a catalog offering.
    id str
    (String) The unique identifier for this resource group.
    name str
    The name of the image.
    remote_account_id str
    Filters the collection to images with a remote account id matching the specified value. Accepted values are provider, user, or a valid account ID.
    resource_group str
    The id of the resource group.
    status str
    Status of the image. Accepted values: available, deleting, deprecated, failed, obsolete, pending, tentative, unusable
    user_data_formats Sequence[str]

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    visibility str
    Visibility of the image. Accepted values: private, public
    catalogManaged Boolean
    Lists only those images which are managed as part of a catalog offering.
    id String
    (String) The unique identifier for this resource group.
    name String
    The name of the image.
    remoteAccountId String
    Filters the collection to images with a remote account id matching the specified value. Accepted values are provider, user, or a valid account ID.
    resourceGroup String
    The id of the resource group.
    status String
    Status of the image. Accepted values: available, deleting, deprecated, failed, obsolete, pending, tentative, unusable
    userDataFormats List<String>

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    visibility String
    Visibility of the image. Accepted values: private, public

    getIsImages Result

    The following output properties are available:

    Id string
    (String) The unique identifier for this resource group.
    Images List<GetIsImagesImage>
    (List) List of all images in the IBM Cloud Infrastructure.
    CatalogManaged bool
    Name string
    (String) The globally unique name for this zone.
    RemoteAccountId string
    ResourceGroup string
    (List) The resource group object, for this image.
    Status string
    (String) The status of this image.
    UserDataFormats List<string>
    (String) The user data format for this image.
    Visibility string
    (String) The visibility of the image public or private.
    Id string
    (String) The unique identifier for this resource group.
    Images []GetIsImagesImage
    (List) List of all images in the IBM Cloud Infrastructure.
    CatalogManaged bool
    Name string
    (String) The globally unique name for this zone.
    RemoteAccountId string
    ResourceGroup string
    (List) The resource group object, for this image.
    Status string
    (String) The status of this image.
    UserDataFormats []string
    (String) The user data format for this image.
    Visibility string
    (String) The visibility of the image public or private.
    id String
    (String) The unique identifier for this resource group.
    images List<GetIsImagesImage>
    (List) List of all images in the IBM Cloud Infrastructure.
    catalogManaged Boolean
    name String
    (String) The globally unique name for this zone.
    remoteAccountId String
    resourceGroup String
    (List) The resource group object, for this image.
    status String
    (String) The status of this image.
    userDataFormats List<String>
    (String) The user data format for this image.
    visibility String
    (String) The visibility of the image public or private.
    id string
    (String) The unique identifier for this resource group.
    images GetIsImagesImage[]
    (List) List of all images in the IBM Cloud Infrastructure.
    catalogManaged boolean
    name string
    (String) The globally unique name for this zone.
    remoteAccountId string
    resourceGroup string
    (List) The resource group object, for this image.
    status string
    (String) The status of this image.
    userDataFormats string[]
    (String) The user data format for this image.
    visibility string
    (String) The visibility of the image public or private.
    id str
    (String) The unique identifier for this resource group.
    images Sequence[GetIsImagesImage]
    (List) List of all images in the IBM Cloud Infrastructure.
    catalog_managed bool
    name str
    (String) The globally unique name for this zone.
    remote_account_id str
    resource_group str
    (List) The resource group object, for this image.
    status str
    (String) The status of this image.
    user_data_formats Sequence[str]
    (String) The user data format for this image.
    visibility str
    (String) The visibility of the image public or private.
    id String
    (String) The unique identifier for this resource group.
    images List<Property Map>
    (List) List of all images in the IBM Cloud Infrastructure.
    catalogManaged Boolean
    name String
    (String) The globally unique name for this zone.
    remoteAccountId String
    resourceGroup String
    (List) The resource group object, for this image.
    status String
    (String) The status of this image.
    userDataFormats List<String>
    (String) The user data format for this image.
    visibility String
    (String) The visibility of the image public or private.

    Supporting Types

    GetIsImagesImage

    AccessTags List<string>
    (List) Access management tags associated for image.
    AllowedUses List<GetIsImagesImageAllowedUse>
    (List) The usage constraints to match against the requested instance or bare metal server properties to determine compatibility.
    Architecture string
    (String) The operating system architecture.
    CatalogOfferings List<GetIsImagesImageCatalogOffering>
    (List) The catalog offering for this image.
    Checksum string
    (String) The SHA256 checksum for this image.
    Crn string
    (String) The CRN for this image.
    Encryption string
    (String) The type of encryption used on the image.
    EncryptionKey string
    (String) The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    The name of the image.
    OperatingSystems List<GetIsImagesImageOperatingSystem>
    (List) The operating system details.
    Os string
    (String) The name of the Operating System.
    Remotes List<GetIsImagesImageRemote>
    (List) If present, this property indicates that the resource associated with this reference is remote and therefore may not be directly retrievable.
    ResourceGroups List<GetIsImagesImageResourceGroup>
    The id of the resource group.
    SourceVolume string
    (String) The source volume id of the image.
    Status string
    Status of the image. Accepted values: available, deleting, deprecated, failed, obsolete, pending, tentative, unusable
    StatusReasons List<GetIsImagesImageStatusReason>
    (List) The reasons for the current status (if any).
    UserDataFormat string

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    Visibility string
    Visibility of the image. Accepted values: private, public
    Zones List<GetIsImagesImageZone>
    (List) The zones in which this image is available for use. If the image has a status of available or deprecated, this will include all zones in the region.If the image has a status of partially_available, this will include one or more zones in the region. If the image has a status of failed, obsolete, pending, or unusable, this will be empty. Nested schema for zones:
    AccessTags []string
    (List) Access management tags associated for image.
    AllowedUses []GetIsImagesImageAllowedUse
    (List) The usage constraints to match against the requested instance or bare metal server properties to determine compatibility.
    Architecture string
    (String) The operating system architecture.
    CatalogOfferings []GetIsImagesImageCatalogOffering
    (List) The catalog offering for this image.
    Checksum string
    (String) The SHA256 checksum for this image.
    Crn string
    (String) The CRN for this image.
    Encryption string
    (String) The type of encryption used on the image.
    EncryptionKey string
    (String) The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    The name of the image.
    OperatingSystems []GetIsImagesImageOperatingSystem
    (List) The operating system details.
    Os string
    (String) The name of the Operating System.
    Remotes []GetIsImagesImageRemote
    (List) If present, this property indicates that the resource associated with this reference is remote and therefore may not be directly retrievable.
    ResourceGroups []GetIsImagesImageResourceGroup
    The id of the resource group.
    SourceVolume string
    (String) The source volume id of the image.
    Status string
    Status of the image. Accepted values: available, deleting, deprecated, failed, obsolete, pending, tentative, unusable
    StatusReasons []GetIsImagesImageStatusReason
    (List) The reasons for the current status (if any).
    UserDataFormat string

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    Visibility string
    Visibility of the image. Accepted values: private, public
    Zones []GetIsImagesImageZone
    (List) The zones in which this image is available for use. If the image has a status of available or deprecated, this will include all zones in the region.If the image has a status of partially_available, this will include one or more zones in the region. If the image has a status of failed, obsolete, pending, or unusable, this will be empty. Nested schema for zones:
    accessTags List<String>
    (List) Access management tags associated for image.
    allowedUses List<GetIsImagesImageAllowedUse>
    (List) The usage constraints to match against the requested instance or bare metal server properties to determine compatibility.
    architecture String
    (String) The operating system architecture.
    catalogOfferings List<GetIsImagesImageCatalogOffering>
    (List) The catalog offering for this image.
    checksum String
    (String) The SHA256 checksum for this image.
    crn String
    (String) The CRN for this image.
    encryption String
    (String) The type of encryption used on the image.
    encryptionKey String
    (String) The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
    id String
    (String) The unique identifier for this resource group.
    name String
    The name of the image.
    operatingSystems List<GetIsImagesImageOperatingSystem>
    (List) The operating system details.
    os String
    (String) The name of the Operating System.
    remotes List<GetIsImagesImageRemote>
    (List) If present, this property indicates that the resource associated with this reference is remote and therefore may not be directly retrievable.
    resourceGroups List<GetIsImagesImageResourceGroup>
    The id of the resource group.
    sourceVolume String
    (String) The source volume id of the image.
    status String
    Status of the image. Accepted values: available, deleting, deprecated, failed, obsolete, pending, tentative, unusable
    statusReasons List<GetIsImagesImageStatusReason>
    (List) The reasons for the current status (if any).
    userDataFormat String

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    visibility String
    Visibility of the image. Accepted values: private, public
    zones List<GetIsImagesImageZone>
    (List) The zones in which this image is available for use. If the image has a status of available or deprecated, this will include all zones in the region.If the image has a status of partially_available, this will include one or more zones in the region. If the image has a status of failed, obsolete, pending, or unusable, this will be empty. Nested schema for zones:
    accessTags string[]
    (List) Access management tags associated for image.
    allowedUses GetIsImagesImageAllowedUse[]
    (List) The usage constraints to match against the requested instance or bare metal server properties to determine compatibility.
    architecture string
    (String) The operating system architecture.
    catalogOfferings GetIsImagesImageCatalogOffering[]
    (List) The catalog offering for this image.
    checksum string
    (String) The SHA256 checksum for this image.
    crn string
    (String) The CRN for this image.
    encryption string
    (String) The type of encryption used on the image.
    encryptionKey string
    (String) The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
    id string
    (String) The unique identifier for this resource group.
    name string
    The name of the image.
    operatingSystems GetIsImagesImageOperatingSystem[]
    (List) The operating system details.
    os string
    (String) The name of the Operating System.
    remotes GetIsImagesImageRemote[]
    (List) If present, this property indicates that the resource associated with this reference is remote and therefore may not be directly retrievable.
    resourceGroups GetIsImagesImageResourceGroup[]
    The id of the resource group.
    sourceVolume string
    (String) The source volume id of the image.
    status string
    Status of the image. Accepted values: available, deleting, deprecated, failed, obsolete, pending, tentative, unusable
    statusReasons GetIsImagesImageStatusReason[]
    (List) The reasons for the current status (if any).
    userDataFormat string

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    visibility string
    Visibility of the image. Accepted values: private, public
    zones GetIsImagesImageZone[]
    (List) The zones in which this image is available for use. If the image has a status of available or deprecated, this will include all zones in the region.If the image has a status of partially_available, this will include one or more zones in the region. If the image has a status of failed, obsolete, pending, or unusable, this will be empty. Nested schema for zones:
    access_tags Sequence[str]
    (List) Access management tags associated for image.
    allowed_uses Sequence[GetIsImagesImageAllowedUse]
    (List) The usage constraints to match against the requested instance or bare metal server properties to determine compatibility.
    architecture str
    (String) The operating system architecture.
    catalog_offerings Sequence[GetIsImagesImageCatalogOffering]
    (List) The catalog offering for this image.
    checksum str
    (String) The SHA256 checksum for this image.
    crn str
    (String) The CRN for this image.
    encryption str
    (String) The type of encryption used on the image.
    encryption_key str
    (String) The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
    id str
    (String) The unique identifier for this resource group.
    name str
    The name of the image.
    operating_systems Sequence[GetIsImagesImageOperatingSystem]
    (List) The operating system details.
    os str
    (String) The name of the Operating System.
    remotes Sequence[GetIsImagesImageRemote]
    (List) If present, this property indicates that the resource associated with this reference is remote and therefore may not be directly retrievable.
    resource_groups Sequence[GetIsImagesImageResourceGroup]
    The id of the resource group.
    source_volume str
    (String) The source volume id of the image.
    status str
    Status of the image. Accepted values: available, deleting, deprecated, failed, obsolete, pending, tentative, unusable
    status_reasons Sequence[GetIsImagesImageStatusReason]
    (List) The reasons for the current status (if any).
    user_data_format str

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    visibility str
    Visibility of the image. Accepted values: private, public
    zones Sequence[GetIsImagesImageZone]
    (List) The zones in which this image is available for use. If the image has a status of available or deprecated, this will include all zones in the region.If the image has a status of partially_available, this will include one or more zones in the region. If the image has a status of failed, obsolete, pending, or unusable, this will be empty. Nested schema for zones:
    accessTags List<String>
    (List) Access management tags associated for image.
    allowedUses List<Property Map>
    (List) The usage constraints to match against the requested instance or bare metal server properties to determine compatibility.
    architecture String
    (String) The operating system architecture.
    catalogOfferings List<Property Map>
    (List) The catalog offering for this image.
    checksum String
    (String) The SHA256 checksum for this image.
    crn String
    (String) The CRN for this image.
    encryption String
    (String) The type of encryption used on the image.
    encryptionKey String
    (String) The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
    id String
    (String) The unique identifier for this resource group.
    name String
    The name of the image.
    operatingSystems List<Property Map>
    (List) The operating system details.
    os String
    (String) The name of the Operating System.
    remotes List<Property Map>
    (List) If present, this property indicates that the resource associated with this reference is remote and therefore may not be directly retrievable.
    resourceGroups List<Property Map>
    The id of the resource group.
    sourceVolume String
    (String) The source volume id of the image.
    status String
    Status of the image. Accepted values: available, deleting, deprecated, failed, obsolete, pending, tentative, unusable
    statusReasons List<Property Map>
    (List) The reasons for the current status (if any).
    userDataFormat String

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    visibility String
    Visibility of the image. Accepted values: private, public
    zones List<Property Map>
    (List) The zones in which this image is available for use. If the image has a status of available or deprecated, this will include all zones in the region.If the image has a status of partially_available, this will include one or more zones in the region. If the image has a status of failed, obsolete, pending, or unusable, this will be empty. Nested schema for zones:

    GetIsImagesImageAllowedUse

    ApiVersion string
    (String) The API version with which to evaluate the expressions.
    BareMetalServer string
    (String) The expression that must be satisfied by the properties of a bare metal server provisioned using this image. If unspecified, the expression will be set to true. The expression follows Common Expression Language, but does not support built-in functions and macros.
    Instance string
    (String) The expression that must be satisfied by the properties of a virtual server instance provisioned using this image. If unspecified, the expression will be set to true. The expression follows Common Expression Language, but does not support built-in functions and macros.
    ApiVersion string
    (String) The API version with which to evaluate the expressions.
    BareMetalServer string
    (String) The expression that must be satisfied by the properties of a bare metal server provisioned using this image. If unspecified, the expression will be set to true. The expression follows Common Expression Language, but does not support built-in functions and macros.
    Instance string
    (String) The expression that must be satisfied by the properties of a virtual server instance provisioned using this image. If unspecified, the expression will be set to true. The expression follows Common Expression Language, but does not support built-in functions and macros.
    apiVersion String
    (String) The API version with which to evaluate the expressions.
    bareMetalServer String
    (String) The expression that must be satisfied by the properties of a bare metal server provisioned using this image. If unspecified, the expression will be set to true. The expression follows Common Expression Language, but does not support built-in functions and macros.
    instance String
    (String) The expression that must be satisfied by the properties of a virtual server instance provisioned using this image. If unspecified, the expression will be set to true. The expression follows Common Expression Language, but does not support built-in functions and macros.
    apiVersion string
    (String) The API version with which to evaluate the expressions.
    bareMetalServer string
    (String) The expression that must be satisfied by the properties of a bare metal server provisioned using this image. If unspecified, the expression will be set to true. The expression follows Common Expression Language, but does not support built-in functions and macros.
    instance string
    (String) The expression that must be satisfied by the properties of a virtual server instance provisioned using this image. If unspecified, the expression will be set to true. The expression follows Common Expression Language, but does not support built-in functions and macros.
    api_version str
    (String) The API version with which to evaluate the expressions.
    bare_metal_server str
    (String) The expression that must be satisfied by the properties of a bare metal server provisioned using this image. If unspecified, the expression will be set to true. The expression follows Common Expression Language, but does not support built-in functions and macros.
    instance str
    (String) The expression that must be satisfied by the properties of a virtual server instance provisioned using this image. If unspecified, the expression will be set to true. The expression follows Common Expression Language, but does not support built-in functions and macros.
    apiVersion String
    (String) The API version with which to evaluate the expressions.
    bareMetalServer String
    (String) The expression that must be satisfied by the properties of a bare metal server provisioned using this image. If unspecified, the expression will be set to true. The expression follows Common Expression Language, but does not support built-in functions and macros.
    instance String
    (String) The expression that must be satisfied by the properties of a virtual server instance provisioned using this image. If unspecified, the expression will be set to true. The expression follows Common Expression Language, but does not support built-in functions and macros.

    GetIsImagesImageCatalogOffering

    Managed bool
    (Bool) Indicates whether this image is managed as part of a catalog offering. If an image is managed, accounts in the same enterprise with access to that catalog can specify the image's catalog offering version CRN to provision virtual server instances using the image.
    Versions List<GetIsImagesImageCatalogOfferingVersion>
    (String) The major release version of this operating system.
    Managed bool
    (Bool) Indicates whether this image is managed as part of a catalog offering. If an image is managed, accounts in the same enterprise with access to that catalog can specify the image's catalog offering version CRN to provision virtual server instances using the image.
    Versions []GetIsImagesImageCatalogOfferingVersion
    (String) The major release version of this operating system.
    managed Boolean
    (Bool) Indicates whether this image is managed as part of a catalog offering. If an image is managed, accounts in the same enterprise with access to that catalog can specify the image's catalog offering version CRN to provision virtual server instances using the image.
    versions List<GetIsImagesImageCatalogOfferingVersion>
    (String) The major release version of this operating system.
    managed boolean
    (Bool) Indicates whether this image is managed as part of a catalog offering. If an image is managed, accounts in the same enterprise with access to that catalog can specify the image's catalog offering version CRN to provision virtual server instances using the image.
    versions GetIsImagesImageCatalogOfferingVersion[]
    (String) The major release version of this operating system.
    managed bool
    (Bool) Indicates whether this image is managed as part of a catalog offering. If an image is managed, accounts in the same enterprise with access to that catalog can specify the image's catalog offering version CRN to provision virtual server instances using the image.
    versions Sequence[GetIsImagesImageCatalogOfferingVersion]
    (String) The major release version of this operating system.
    managed Boolean
    (Bool) Indicates whether this image is managed as part of a catalog offering. If an image is managed, accounts in the same enterprise with access to that catalog can specify the image's catalog offering version CRN to provision virtual server instances using the image.
    versions List<Property Map>
    (String) The major release version of this operating system.

    GetIsImagesImageCatalogOfferingVersion

    Crn string
    (String) The CRN for this image.
    Deleteds List<GetIsImagesImageCatalogOfferingVersionDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Crn string
    (String) The CRN for this image.
    Deleteds []GetIsImagesImageCatalogOfferingVersionDeleted
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    crn String
    (String) The CRN for this image.
    deleteds List<GetIsImagesImageCatalogOfferingVersionDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    crn string
    (String) The CRN for this image.
    deleteds GetIsImagesImageCatalogOfferingVersionDeleted[]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    crn str
    (String) The CRN for this image.
    deleteds Sequence[GetIsImagesImageCatalogOfferingVersionDeleted]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    crn String
    (String) The CRN for this image.
    deleteds List<Property Map>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.

    GetIsImagesImageCatalogOfferingVersionDeleted

    MoreInfo string
    (String) Link to documentation about this status reason.
    MoreInfo string
    (String) Link to documentation about this status reason.
    moreInfo String
    (String) Link to documentation about this status reason.
    moreInfo string
    (String) Link to documentation about this status reason.
    more_info str
    (String) Link to documentation about this status reason.
    moreInfo String
    (String) Link to documentation about this status reason.

    GetIsImagesImageOperatingSystem

    AllowUserImageCreation bool
    (Bool) Users may create new images with this operating system.
    Architecture string
    (String) The operating system architecture.
    DedicatedHostOnly bool
    (Bool) Images with this operating system can only be used on dedicated hosts or dedicated host groups.
    DisplayName string
    (String) A unique, display-friendly name for the operating system.
    Family string
    (String) The software family for this operating system.
    Href string
    (String) The URL for this zone.
    Name string
    The name of the image.
    UserDataFormat string

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    Vendor string
    (String) The vendor of the operating system.
    Version string
    (String) The major release version of this operating system.
    AllowUserImageCreation bool
    (Bool) Users may create new images with this operating system.
    Architecture string
    (String) The operating system architecture.
    DedicatedHostOnly bool
    (Bool) Images with this operating system can only be used on dedicated hosts or dedicated host groups.
    DisplayName string
    (String) A unique, display-friendly name for the operating system.
    Family string
    (String) The software family for this operating system.
    Href string
    (String) The URL for this zone.
    Name string
    The name of the image.
    UserDataFormat string

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    Vendor string
    (String) The vendor of the operating system.
    Version string
    (String) The major release version of this operating system.
    allowUserImageCreation Boolean
    (Bool) Users may create new images with this operating system.
    architecture String
    (String) The operating system architecture.
    dedicatedHostOnly Boolean
    (Bool) Images with this operating system can only be used on dedicated hosts or dedicated host groups.
    displayName String
    (String) A unique, display-friendly name for the operating system.
    family String
    (String) The software family for this operating system.
    href String
    (String) The URL for this zone.
    name String
    The name of the image.
    userDataFormat String

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    vendor String
    (String) The vendor of the operating system.
    version String
    (String) The major release version of this operating system.
    allowUserImageCreation boolean
    (Bool) Users may create new images with this operating system.
    architecture string
    (String) The operating system architecture.
    dedicatedHostOnly boolean
    (Bool) Images with this operating system can only be used on dedicated hosts or dedicated host groups.
    displayName string
    (String) A unique, display-friendly name for the operating system.
    family string
    (String) The software family for this operating system.
    href string
    (String) The URL for this zone.
    name string
    The name of the image.
    userDataFormat string

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    vendor string
    (String) The vendor of the operating system.
    version string
    (String) The major release version of this operating system.
    allow_user_image_creation bool
    (Bool) Users may create new images with this operating system.
    architecture str
    (String) The operating system architecture.
    dedicated_host_only bool
    (Bool) Images with this operating system can only be used on dedicated hosts or dedicated host groups.
    display_name str
    (String) A unique, display-friendly name for the operating system.
    family str
    (String) The software family for this operating system.
    href str
    (String) The URL for this zone.
    name str
    The name of the image.
    user_data_format str

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    vendor str
    (String) The vendor of the operating system.
    version str
    (String) The major release version of this operating system.
    allowUserImageCreation Boolean
    (Bool) Users may create new images with this operating system.
    architecture String
    (String) The operating system architecture.
    dedicatedHostOnly Boolean
    (Bool) Images with this operating system can only be used on dedicated hosts or dedicated host groups.
    displayName String
    (String) A unique, display-friendly name for the operating system.
    family String
    (String) The software family for this operating system.
    href String
    (String) The URL for this zone.
    name String
    The name of the image.
    userDataFormat String

    Filters the collection to images with a user_data_format property matching one of the specified values.

    Note: Supported values are:

    vendor String
    (String) The vendor of the operating system.
    version String
    (String) The major release version of this operating system.

    GetIsImagesImageRemote

    Accounts List<GetIsImagesImageRemoteAccount>
    (List) Indicates that the referenced resource is remote to this account, and identifies the owning account.
    Accounts []GetIsImagesImageRemoteAccount
    (List) Indicates that the referenced resource is remote to this account, and identifies the owning account.
    accounts List<GetIsImagesImageRemoteAccount>
    (List) Indicates that the referenced resource is remote to this account, and identifies the owning account.
    accounts GetIsImagesImageRemoteAccount[]
    (List) Indicates that the referenced resource is remote to this account, and identifies the owning account.
    accounts Sequence[GetIsImagesImageRemoteAccount]
    (List) Indicates that the referenced resource is remote to this account, and identifies the owning account.
    accounts List<Property Map>
    (List) Indicates that the referenced resource is remote to this account, and identifies the owning account.

    GetIsImagesImageRemoteAccount

    Id string
    (String) The unique identifier for this resource group.
    ResourceType string
    (String) The resource type.
    Id string
    (String) The unique identifier for this resource group.
    ResourceType string
    (String) The resource type.
    id String
    (String) The unique identifier for this resource group.
    resourceType String
    (String) The resource type.
    id string
    (String) The unique identifier for this resource group.
    resourceType string
    (String) The resource type.
    id str
    (String) The unique identifier for this resource group.
    resource_type str
    (String) The resource type.
    id String
    (String) The unique identifier for this resource group.
    resourceType String
    (String) The resource type.

    GetIsImagesImageResourceGroup

    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    The name of the image.
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this resource group.
    Name string
    The name of the image.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this resource group.
    name String
    The name of the image.
    href string
    (String) The URL for this zone.
    id string
    (String) The unique identifier for this resource group.
    name string
    The name of the image.
    href str
    (String) The URL for this zone.
    id str
    (String) The unique identifier for this resource group.
    name str
    The name of the image.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this resource group.
    name String
    The name of the image.

    GetIsImagesImageStatusReason

    Code string
    (String) The status reason code.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason.
    Code string
    (String) The status reason code.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason.
    code String
    (String) The status reason code.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason.
    code string
    (String) The status reason code.
    message string
    (String) An explanation of the status reason.
    moreInfo string
    (String) Link to documentation about this status reason.
    code str
    (String) The status reason code.
    message str
    (String) An explanation of the status reason.
    more_info str
    (String) Link to documentation about this status reason.
    code String
    (String) The status reason code.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason.

    GetIsImagesImageZone

    Href string
    (String) The URL for this zone.
    Name string
    The name of the image.
    Href string
    (String) The URL for this zone.
    Name string
    The name of the image.
    href String
    (String) The URL for this zone.
    name String
    The name of the image.
    href string
    (String) The URL for this zone.
    name string
    The name of the image.
    href str
    (String) The URL for this zone.
    name str
    The name of the image.
    href String
    (String) The URL for this zone.
    name String
    The name of the image.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    Viewing docs for ibm 2.1.0
    published on Tuesday, May 5, 2026 by ibm-cloud
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm
      Try Pulumi Cloud free. Your team will thank you.