Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiCloudInstance
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getPiCloudInstance

Explore with Pulumi AI

ibm logo
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve information about an existing IBM Power Virtual Server Cloud Instance as a read-only data source. For more information, about IBM power virtual server cloud, see getting started with IBM Power Systems Virtual Servers.

    Example Usage

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

const dsCloudInstance = ibm.getPiCloudInstance({
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
});

    import pulumi
import pulumi_ibm as ibm

ds_cloud_instance = ibm.get_pi_cloud_instance(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.GetPiCloudInstance(ctx, &ibm.GetPiCloudInstanceArgs{
			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 dsCloudInstance = Ibm.GetPiCloudInstance.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.GetPiCloudInstanceArgs;
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 dsCloudInstance = IbmFunctions.getPiCloudInstance(GetPiCloudInstanceArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .build());

    }
}

    variables:
  dsCloudInstance:
    fn::invoke:
      function: ibm:getPiCloudInstance
      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 getPiCloudInstance

    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 getPiCloudInstance(args: GetPiCloudInstanceArgs, opts?: InvokeOptions): Promise<GetPiCloudInstanceResult>
function getPiCloudInstanceOutput(args: GetPiCloudInstanceOutputArgs, opts?: InvokeOptions): Output<GetPiCloudInstanceResult>
    def get_pi_cloud_instance(id: Optional[str] = None,
                          pi_cloud_instance_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPiCloudInstanceResult
def get_pi_cloud_instance_output(id: Optional[pulumi.Input[str]] = None,
                          pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPiCloudInstanceResult]
    func GetPiCloudInstance(ctx *Context, args *GetPiCloudInstanceArgs, opts ...InvokeOption) (*GetPiCloudInstanceResult, error)
func GetPiCloudInstanceOutput(ctx *Context, args *GetPiCloudInstanceOutputArgs, opts ...InvokeOption) GetPiCloudInstanceResultOutput

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

    public static class GetPiCloudInstance 
{
    public static Task<GetPiCloudInstanceResult> InvokeAsync(GetPiCloudInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetPiCloudInstanceResult> Invoke(GetPiCloudInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiCloudInstanceResult> getPiCloudInstance(GetPiCloudInstanceArgs args, InvokeOptions options)
public static Output<GetPiCloudInstanceResult> getPiCloudInstance(GetPiCloudInstanceArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    (String) PVM Instance ID.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    (String) PVM Instance ID.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) PVM Instance ID.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    id string
    (String) PVM Instance ID.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    id str
    (String) PVM Instance ID.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) PVM Instance ID.

    getPiCloudInstance Result

    The following output properties are available:

    Capabilities List<string>
    (String) Lists the capabilities for this cloud instance.
    Enabled bool
    (Bool) Indicates whether the tenant is enabled.
    Id string
    (String) PVM Instance ID.
    PiCloudInstanceId string
    PvmInstances List<GetPiCloudInstancePvmInstance>
    (List) PVM instances owned by the Cloud Instance.
    Region string
    (String) The region the cloud instance lives.
    TenantId string
    (String) The tenant ID that owns this cloud instance.
    TotalInstances double
    (String) The count of lpars that belong to this specific cloud instance.
    TotalMemoryConsumed double
    (String) The total memory consumed by this service instance.
    TotalProcessorsConsumed double
    (String) The total processors consumed by this service instance.
    TotalSsdStorageConsumed double
    (String) The total SSD Storage consumed by this service instance.
    TotalStandardStorageConsumed double
    (String) The total Standard Storage consumed by this service instance.
    Capabilities []string
    (String) Lists the capabilities for this cloud instance.
    Enabled bool
    (Bool) Indicates whether the tenant is enabled.
    Id string
    (String) PVM Instance ID.
    PiCloudInstanceId string
    PvmInstances []GetPiCloudInstancePvmInstance
    (List) PVM instances owned by the Cloud Instance.
    Region string
    (String) The region the cloud instance lives.
    TenantId string
    (String) The tenant ID that owns this cloud instance.
    TotalInstances float64
    (String) The count of lpars that belong to this specific cloud instance.
    TotalMemoryConsumed float64
    (String) The total memory consumed by this service instance.
    TotalProcessorsConsumed float64
    (String) The total processors consumed by this service instance.
    TotalSsdStorageConsumed float64
    (String) The total SSD Storage consumed by this service instance.
    TotalStandardStorageConsumed float64
    (String) The total Standard Storage consumed by this service instance.
    capabilities List<String>
    (String) Lists the capabilities for this cloud instance.
    enabled Boolean
    (Bool) Indicates whether the tenant is enabled.
    id String
    (String) PVM Instance ID.
    piCloudInstanceId String
    pvmInstances List<GetPiCloudInstancePvmInstance>
    (List) PVM instances owned by the Cloud Instance.
    region String
    (String) The region the cloud instance lives.
    tenantId String
    (String) The tenant ID that owns this cloud instance.
    totalInstances Double
    (String) The count of lpars that belong to this specific cloud instance.
    totalMemoryConsumed Double
    (String) The total memory consumed by this service instance.
    totalProcessorsConsumed Double
    (String) The total processors consumed by this service instance.
    totalSsdStorageConsumed Double
    (String) The total SSD Storage consumed by this service instance.
    totalStandardStorageConsumed Double
    (String) The total Standard Storage consumed by this service instance.
    capabilities string[]
    (String) Lists the capabilities for this cloud instance.
    enabled boolean
    (Bool) Indicates whether the tenant is enabled.
    id string
    (String) PVM Instance ID.
    piCloudInstanceId string
    pvmInstances GetPiCloudInstancePvmInstance[]
    (List) PVM instances owned by the Cloud Instance.
    region string
    (String) The region the cloud instance lives.
    tenantId string
    (String) The tenant ID that owns this cloud instance.
    totalInstances number
    (String) The count of lpars that belong to this specific cloud instance.
    totalMemoryConsumed number
    (String) The total memory consumed by this service instance.
    totalProcessorsConsumed number
    (String) The total processors consumed by this service instance.
    totalSsdStorageConsumed number
    (String) The total SSD Storage consumed by this service instance.
    totalStandardStorageConsumed number
    (String) The total Standard Storage consumed by this service instance.
    capabilities Sequence[str]
    (String) Lists the capabilities for this cloud instance.
    enabled bool
    (Bool) Indicates whether the tenant is enabled.
    id str
    (String) PVM Instance ID.
    pi_cloud_instance_id str
    pvm_instances Sequence[GetPiCloudInstancePvmInstance]
    (List) PVM instances owned by the Cloud Instance.
    region str
    (String) The region the cloud instance lives.
    tenant_id str
    (String) The tenant ID that owns this cloud instance.
    total_instances float
    (String) The count of lpars that belong to this specific cloud instance.
    total_memory_consumed float
    (String) The total memory consumed by this service instance.
    total_processors_consumed float
    (String) The total processors consumed by this service instance.
    total_ssd_storage_consumed float
    (String) The total SSD Storage consumed by this service instance.
    total_standard_storage_consumed float
    (String) The total Standard Storage consumed by this service instance.
    capabilities List<String>
    (String) Lists the capabilities for this cloud instance.
    enabled Boolean
    (Bool) Indicates whether the tenant is enabled.
    id String
    (String) PVM Instance ID.
    piCloudInstanceId String
    pvmInstances List<Property Map>
    (List) PVM instances owned by the Cloud Instance.
    region String
    (String) The region the cloud instance lives.
    tenantId String
    (String) The tenant ID that owns this cloud instance.
    totalInstances Number
    (String) The count of lpars that belong to this specific cloud instance.
    totalMemoryConsumed Number
    (String) The total memory consumed by this service instance.
    totalProcessorsConsumed Number
    (String) The total processors consumed by this service instance.
    totalSsdStorageConsumed Number
    (String) The total SSD Storage consumed by this service instance.
    totalStandardStorageConsumed Number
    (String) The total Standard Storage consumed by this service instance.

    Supporting Types

    GetPiCloudInstancePvmInstance

    CreationDate string
    (String) Date of PVM instance creation.
    Crn string
    (String) The CRN of this resource.
    Href string
    (String) Link to Cloud Instance resource.
    Id string
    (String) PVM Instance ID.
    Name string
    (String) Name of the server.
    Status string
    (String) The status of the instance.
    Systype string
    (string) System type used to host the instance.
    CreationDate string
    (String) Date of PVM instance creation.
    Crn string
    (String) The CRN of this resource.
    Href string
    (String) Link to Cloud Instance resource.
    Id string
    (String) PVM Instance ID.
    Name string
    (String) Name of the server.
    Status string
    (String) The status of the instance.
    Systype string
    (string) System type used to host the instance.
    creationDate String
    (String) Date of PVM instance creation.
    crn String
    (String) The CRN of this resource.
    href String
    (String) Link to Cloud Instance resource.
    id String
    (String) PVM Instance ID.
    name String
    (String) Name of the server.
    status String
    (String) The status of the instance.
    systype String
    (string) System type used to host the instance.
    creationDate string
    (String) Date of PVM instance creation.
    crn string
    (String) The CRN of this resource.
    href string
    (String) Link to Cloud Instance resource.
    id string
    (String) PVM Instance ID.
    name string
    (String) Name of the server.
    status string
    (String) The status of the instance.
    systype string
    (string) System type used to host the instance.
    creation_date str
    (String) Date of PVM instance creation.
    crn str
    (String) The CRN of this resource.
    href str
    (String) Link to Cloud Instance resource.
    id str
    (String) PVM Instance ID.
    name str
    (String) Name of the server.
    status str
    (String) The status of the instance.
    systype str
    (string) System type used to host the instance.
    creationDate String
    (String) Date of PVM instance creation.
    crn String
    (String) The CRN of this resource.
    href String
    (String) Link to Cloud Instance resource.
    id String
    (String) PVM Instance ID.
    name String
    (String) Name of the server.
    status String
    (String) The status of the instance.
    systype String
    (string) System type used to host the instance.

    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.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm