1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiImages
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getPiImages

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Retrieve a list of supported images that you can use in your Power Systems Virtual Server instance. The image represents the version of the operation system that is installed in your Power Systems Virtual Server instance. For more information, about power instance images, see capturing and exporting a virtual machine (VM).

    Example Usage

    The following example retrieves all images for a cloud instance ID.

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const dsImages = ibm.getPiImages({
        piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    ds_images = ibm.get_pi_images(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.GetPiImages(ctx, &ibm.GetPiImagesArgs{
    			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    		}, 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.GetPiImages.Invoke(new()
        {
            PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        });
    
    });
    
    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.GetPiImagesArgs;
    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.getPiImages(GetPiImagesArgs.builder()
                .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
                .build());
    
        }
    }
    
    variables:
      dsImages:
        fn::invoke:
          function: ibm:getPiImages
          arguments:
            piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
    

    Notes

    • Please find supported Regions for endpoints.
    • If a Power cloud instance is provisioned at lon04, The provider level attributes should be as follows:
      • region - lon
      • zone - lon04

    Example usage:

    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) {
        }
    }
    
    {}
    

    Using getPiImages

    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 getPiImages(args: GetPiImagesArgs, opts?: InvokeOptions): Promise<GetPiImagesResult>
    function getPiImagesOutput(args: GetPiImagesOutputArgs, opts?: InvokeOptions): Output<GetPiImagesResult>
    def get_pi_images(id: Optional[str] = None,
                      pi_cloud_instance_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetPiImagesResult
    def get_pi_images_output(id: Optional[pulumi.Input[str]] = None,
                      pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetPiImagesResult]
    func GetPiImages(ctx *Context, args *GetPiImagesArgs, opts ...InvokeOption) (*GetPiImagesResult, error)
    func GetPiImagesOutput(ctx *Context, args *GetPiImagesOutputArgs, opts ...InvokeOption) GetPiImagesResultOutput

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

    public static class GetPiImages 
    {
        public static Task<GetPiImagesResult> InvokeAsync(GetPiImagesArgs args, InvokeOptions? opts = null)
        public static Output<GetPiImagesResult> Invoke(GetPiImagesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPiImagesResult> getPiImages(GetPiImagesArgs args, InvokeOptions options)
    public static Output<GetPiImagesResult> getPiImages(GetPiImagesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getPiImages:getPiImages
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    (String) The unique identifier of an image.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    (String) The unique identifier of an image.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) The unique identifier of an image.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    id string
    (String) The unique identifier of an image.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    id str
    (String) The unique identifier of an image.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) The unique identifier of an image.

    getPiImages Result

    The following output properties are available:

    Id string
    (String) The unique identifier of an image.
    ImageInfos List<GetPiImagesImageInfo>
    (List) List of all supported images.
    PiCloudInstanceId string
    Id string
    (String) The unique identifier of an image.
    ImageInfos []GetPiImagesImageInfo
    (List) List of all supported images.
    PiCloudInstanceId string
    id String
    (String) The unique identifier of an image.
    imageInfos List<GetPiImagesImageInfo>
    (List) List of all supported images.
    piCloudInstanceId String
    id string
    (String) The unique identifier of an image.
    imageInfos GetPiImagesImageInfo[]
    (List) List of all supported images.
    piCloudInstanceId string
    id str
    (String) The unique identifier of an image.
    image_infos Sequence[GetPiImagesImageInfo]
    (List) List of all supported images.
    pi_cloud_instance_id str
    id String
    (String) The unique identifier of an image.
    imageInfos List<Property Map>
    (List) List of all supported images.
    piCloudInstanceId String

    Supporting Types

    GetPiImagesImageInfo

    Crn string
    (String) The CRN of this resource.
    Href string
    (String) The hyper link of an image.
    Id string
    (String) The unique identifier of an image.
    ImageType string
    (String) The identifier of this image type.
    Name string
    (String) The name of an image.
    SourceChecksum string
    (String) Checksum of the image.
    State string
    (String) The state of an image.
    StoragePool string
    (String) Storage pool where image resides.
    StorageType string
    (String) The storage type of an image.
    UserTags List<string>
    (List) List of user tags attached to the resource.
    Crn string
    (String) The CRN of this resource.
    Href string
    (String) The hyper link of an image.
    Id string
    (String) The unique identifier of an image.
    ImageType string
    (String) The identifier of this image type.
    Name string
    (String) The name of an image.
    SourceChecksum string
    (String) Checksum of the image.
    State string
    (String) The state of an image.
    StoragePool string
    (String) Storage pool where image resides.
    StorageType string
    (String) The storage type of an image.
    UserTags []string
    (List) List of user tags attached to the resource.
    crn String
    (String) The CRN of this resource.
    href String
    (String) The hyper link of an image.
    id String
    (String) The unique identifier of an image.
    imageType String
    (String) The identifier of this image type.
    name String
    (String) The name of an image.
    sourceChecksum String
    (String) Checksum of the image.
    state String
    (String) The state of an image.
    storagePool String
    (String) Storage pool where image resides.
    storageType String
    (String) The storage type of an image.
    userTags List<String>
    (List) List of user tags attached to the resource.
    crn string
    (String) The CRN of this resource.
    href string
    (String) The hyper link of an image.
    id string
    (String) The unique identifier of an image.
    imageType string
    (String) The identifier of this image type.
    name string
    (String) The name of an image.
    sourceChecksum string
    (String) Checksum of the image.
    state string
    (String) The state of an image.
    storagePool string
    (String) Storage pool where image resides.
    storageType string
    (String) The storage type of an image.
    userTags string[]
    (List) List of user tags attached to the resource.
    crn str
    (String) The CRN of this resource.
    href str
    (String) The hyper link of an image.
    id str
    (String) The unique identifier of an image.
    image_type str
    (String) The identifier of this image type.
    name str
    (String) The name of an image.
    source_checksum str
    (String) Checksum of the image.
    state str
    (String) The state of an image.
    storage_pool str
    (String) Storage pool where image resides.
    storage_type str
    (String) The storage type of an image.
    user_tags Sequence[str]
    (List) List of user tags attached to the resource.
    crn String
    (String) The CRN of this resource.
    href String
    (String) The hyper link of an image.
    id String
    (String) The unique identifier of an image.
    imageType String
    (String) The identifier of this image type.
    name String
    (String) The name of an image.
    sourceChecksum String
    (String) Checksum of the image.
    state String
    (String) The state of an image.
    storagePool String
    (String) Storage pool where image resides.
    storageType String
    (String) The storage type of an image.
    userTags List<String>
    (List) List of user tags attached to the resource.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud